com.google.api.services.dfareporting.model.DimensionValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dfareporting Show documentation
The newest version!
/*
 * 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.dfareporting.model;

/**
 * Represents a DimensionValue resource.
 *
 *  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 Campaign Manager 360 API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class DimensionValue extends com.google.api.client.json.GenericJson {

  /**
   * The name of the dimension.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String dimensionName;

  /**
   * The eTag of this response for caching purposes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String etag;

  /**
   * The ID associated with the value if available.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String id;

  /**
   * The kind of resource this is, in this case dfareporting#dimensionValue.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kind;

  /**
   * Determines how the 'value' field is matched when filtering. If not specified, defaults to
   * EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length
   * character sequences, and it can be escaped with a backslash. Note, only paid search dimensions
   * ('dfa:paidSearch*') allow a matchType other than EXACT.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String matchType;

  /**
   * The value of the dimension.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String value;

  /**
   * The name of the dimension.
   * @return value or {@code null} for none
   */
  public java.lang.String getDimensionName() {
    return dimensionName;
  }

  /**
   * The name of the dimension.
   * @param dimensionName dimensionName or {@code null} for none
   */
  public DimensionValue setDimensionName(java.lang.String dimensionName) {
    this.dimensionName = dimensionName;
    return this;
  }

  /**
   * The eTag of this response for caching purposes.
   * @return value or {@code null} for none
   */
  public java.lang.String getEtag() {
    return etag;
  }

  /**
   * The eTag of this response for caching purposes.
   * @param etag etag or {@code null} for none
   */
  public DimensionValue setEtag(java.lang.String etag) {
    this.etag = etag;
    return this;
  }

  /**
   * The ID associated with the value if available.
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * The ID associated with the value if available.
   * @param id id or {@code null} for none
   */
  public DimensionValue setId(java.lang.String id) {
    this.id = id;
    return this;
  }

  /**
   * The kind of resource this is, in this case dfareporting#dimensionValue.
   * @return value or {@code null} for none
   */
  public java.lang.String getKind() {
    return kind;
  }

  /**
   * The kind of resource this is, in this case dfareporting#dimensionValue.
   * @param kind kind or {@code null} for none
   */
  public DimensionValue setKind(java.lang.String kind) {
    this.kind = kind;
    return this;
  }

  /**
   * Determines how the 'value' field is matched when filtering. If not specified, defaults to
   * EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length
   * character sequences, and it can be escaped with a backslash. Note, only paid search dimensions
   * ('dfa:paidSearch*') allow a matchType other than EXACT.
   * @return value or {@code null} for none
   */
  public java.lang.String getMatchType() {
    return matchType;
  }

  /**
   * Determines how the 'value' field is matched when filtering. If not specified, defaults to
   * EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length
   * character sequences, and it can be escaped with a backslash. Note, only paid search dimensions
   * ('dfa:paidSearch*') allow a matchType other than EXACT.
   * @param matchType matchType or {@code null} for none
   */
  public DimensionValue setMatchType(java.lang.String matchType) {
    this.matchType = matchType;
    return this;
  }

  /**
   * The value of the dimension.
   * @return value or {@code null} for none
   */
  public java.lang.String getValue() {
    return value;
  }

  /**
   * The value of the dimension.
   * @param value value or {@code null} for none
   */
  public DimensionValue setValue(java.lang.String value) {
    this.value = value;
    return this;
  }

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

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

}