/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.searchads360.v0.model;

/**
 * A custom column. See Search Ads 360 custom column at
 * https://support.google.com/sa360/answer/9633916
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Search Ads 360 Reporting API. For a detailed
 * explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleAdsSearchads360V0ResourcesCustomColumn extends com.google.api.client.json.GenericJson {

  /**
   * Output only. User-defined description of the custom column.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Output only. ID of the custom column.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long id;

  /**
   * Output only. User-defined name of the custom column.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. True when the custom column is available to be used in the query of
   * SearchAds360Service.Search and SearchAds360Service.SearchStream.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean queryable;

  /**
   * Output only. The list of the referenced system columns of this custom column. For example, A
   * custom column "sum of impressions and clicks" has referenced system columns of
   * {"metrics.clicks", "metrics.impressions"}.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> referencedSystemColumns;

  /**
   * Output only. True when the custom column is referring to one or more attributes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean referencesAttributes;

  /**
   * Output only. True when the custom column is referring to one or more metrics.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean referencesMetrics;

  /**
   * Immutable. The resource name of the custom column. Custom column resource names have the form:
   * `customers/{customer_id}/customColumns/{custom_column_id}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String resourceName;

  /**
   * Output only. The type of the result value of the custom column.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String valueType;

  /**
   * Output only. User-defined description of the custom column.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * Output only. User-defined description of the custom column.
   * @param description description or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Output only. ID of the custom column.
   * @return value or {@code null} for none
   */
  public java.lang.Long getId() {
    return id;
  }

  /**
   * Output only. ID of the custom column.
   * @param id id or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setId(java.lang.Long id) {
    this.id = id;
    return this;
  }

  /**
   * Output only. User-defined name of the custom column.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. User-defined name of the custom column.
   * @param name name or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. True when the custom column is available to be used in the query of
   * SearchAds360Service.Search and SearchAds360Service.SearchStream.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getQueryable() {
    return queryable;
  }

  /**
   * Output only. True when the custom column is available to be used in the query of
   * SearchAds360Service.Search and SearchAds360Service.SearchStream.
   * @param queryable queryable or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setQueryable(java.lang.Boolean queryable) {
    this.queryable = queryable;
    return this;
  }

  /**
   * Output only. The list of the referenced system columns of this custom column. For example, A
   * custom column "sum of impressions and clicks" has referenced system columns of
   * {"metrics.clicks", "metrics.impressions"}.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getReferencedSystemColumns() {
    return referencedSystemColumns;
  }

  /**
   * Output only. The list of the referenced system columns of this custom column. For example, A
   * custom column "sum of impressions and clicks" has referenced system columns of
   * {"metrics.clicks", "metrics.impressions"}.
   * @param referencedSystemColumns referencedSystemColumns or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setReferencedSystemColumns(java.util.List<java.lang.String> referencedSystemColumns) {
    this.referencedSystemColumns = referencedSystemColumns;
    return this;
  }

  /**
   * Output only. True when the custom column is referring to one or more attributes.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getReferencesAttributes() {
    return referencesAttributes;
  }

  /**
   * Output only. True when the custom column is referring to one or more attributes.
   * @param referencesAttributes referencesAttributes or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setReferencesAttributes(java.lang.Boolean referencesAttributes) {
    this.referencesAttributes = referencesAttributes;
    return this;
  }

  /**
   * Output only. True when the custom column is referring to one or more metrics.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getReferencesMetrics() {
    return referencesMetrics;
  }

  /**
   * Output only. True when the custom column is referring to one or more metrics.
   * @param referencesMetrics referencesMetrics or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setReferencesMetrics(java.lang.Boolean referencesMetrics) {
    this.referencesMetrics = referencesMetrics;
    return this;
  }

  /**
   * Immutable. The resource name of the custom column. Custom column resource names have the form:
   * `customers/{customer_id}/customColumns/{custom_column_id}`
   * @return value or {@code null} for none
   */
  public java.lang.String getResourceName() {
    return resourceName;
  }

  /**
   * Immutable. The resource name of the custom column. Custom column resource names have the form:
   * `customers/{customer_id}/customColumns/{custom_column_id}`
   * @param resourceName resourceName or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setResourceName(java.lang.String resourceName) {
    this.resourceName = resourceName;
    return this;
  }

  /**
   * Output only. The type of the result value of the custom column.
   * @return value or {@code null} for none
   */
  public java.lang.String getValueType() {
    return valueType;
  }

  /**
   * Output only. The type of the result value of the custom column.
   * @param valueType valueType or {@code null} for none
   */
  public GoogleAdsSearchads360V0ResourcesCustomColumn setValueType(java.lang.String valueType) {
    this.valueType = valueType;
    return this;
  }

  @Override
  public GoogleAdsSearchads360V0ResourcesCustomColumn set(String fieldName, Object value) {
    return (GoogleAdsSearchads360V0ResourcesCustomColumn) super.set(fieldName, value);
  }

  @Override
  public GoogleAdsSearchads360V0ResourcesCustomColumn clone() {
    return (GoogleAdsSearchads360V0ResourcesCustomColumn) super.clone();
  }

}
