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

Go to download
/*
 * 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;

/**
 * Placement Assignment.
 *
 *  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 PlacementAssignment extends com.google.api.client.json.GenericJson {

  /**
   * Whether this placement assignment is active. When true, the placement will be included in the
   * ad's rotation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean active;

  /**
   * ID of the placement to be assigned. This is a required field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long placementId;

  /**
   * Dimension value for the ID of the placement. This is a read-only, auto-generated field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DimensionValue placementIdDimensionValue;

  /**
   * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-
   * generated when the ad is inserted or updated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean sslRequired;

  /**
   * Whether this placement assignment is active. When true, the placement will be included in the
   * ad's rotation.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getActive() {
    return active;
  }

  /**
   * Whether this placement assignment is active. When true, the placement will be included in the
   * ad's rotation.
   * @param active active or {@code null} for none
   */
  public PlacementAssignment setActive(java.lang.Boolean active) {
    this.active = active;
    return this;
  }

  /**
   * ID of the placement to be assigned. This is a required field.
   * @return value or {@code null} for none
   */
  public java.lang.Long getPlacementId() {
    return placementId;
  }

  /**
   * ID of the placement to be assigned. This is a required field.
   * @param placementId placementId or {@code null} for none
   */
  public PlacementAssignment setPlacementId(java.lang.Long placementId) {
    this.placementId = placementId;
    return this;
  }

  /**
   * Dimension value for the ID of the placement. This is a read-only, auto-generated field.
   * @return value or {@code null} for none
   */
  public DimensionValue getPlacementIdDimensionValue() {
    return placementIdDimensionValue;
  }

  /**
   * Dimension value for the ID of the placement. This is a read-only, auto-generated field.
   * @param placementIdDimensionValue placementIdDimensionValue or {@code null} for none
   */
  public PlacementAssignment setPlacementIdDimensionValue(DimensionValue placementIdDimensionValue) {
    this.placementIdDimensionValue = placementIdDimensionValue;
    return this;
  }

  /**
   * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-
   * generated when the ad is inserted or updated.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSslRequired() {
    return sslRequired;
  }

  /**
   * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-
   * generated when the ad is inserted or updated.
   * @param sslRequired sslRequired or {@code null} for none
   */
  public PlacementAssignment setSslRequired(java.lang.Boolean sslRequired) {
    this.sslRequired = sslRequired;
    return this;
  }

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

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

}