com.google.api.services.content.model.OrderLegacyPromotion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation
There is a newer version: v2.1-rev20241217-2.0.0
Show 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.content.model;

/**
 * Model definition for OrderLegacyPromotion.
 *
 *  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 Content API for Shopping. 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 OrderLegacyPromotion extends com.google.api.client.json.GenericJson {

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List benefits;

  /**
   * The date and time frame when the promotion is active and ready for validation review. Note that
   * the promotion live time may be delayed for a few hours due to the validation review. Start date
   * and end date are separated by a forward slash (/). The start date is specified by the format
   * (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in
   * Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end
   * date is in the same format.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String effectiveDates;

  /**
   * Optional. The text code that corresponds to the promotion when applied on the retailer?s
   * website.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String genericRedemptionCode;

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

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

  /**
   * Whether the promotion is applicable to all products or only specific products. Acceptable
   * values are: - "`allProducts`" - "`specificProducts`"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String productApplicability;

  /**
   * Indicates that the promotion is valid online. Acceptable values are: - "`online`"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String redemptionChannel;

  /**
   * @return value or {@code null} for none
   */
  public java.util.List getBenefits() {
    return benefits;
  }

  /**
   * @param benefits benefits or {@code null} for none
   */
  public OrderLegacyPromotion setBenefits(java.util.List benefits) {
    this.benefits = benefits;
    return this;
  }

  /**
   * The date and time frame when the promotion is active and ready for validation review. Note that
   * the promotion live time may be delayed for a few hours due to the validation review. Start date
   * and end date are separated by a forward slash (/). The start date is specified by the format
   * (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in
   * Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end
   * date is in the same format.
   * @return value or {@code null} for none
   */
  public java.lang.String getEffectiveDates() {
    return effectiveDates;
  }

  /**
   * The date and time frame when the promotion is active and ready for validation review. Note that
   * the promotion live time may be delayed for a few hours due to the validation review. Start date
   * and end date are separated by a forward slash (/). The start date is specified by the format
   * (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in
   * Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end
   * date is in the same format.
   * @param effectiveDates effectiveDates or {@code null} for none
   */
  public OrderLegacyPromotion setEffectiveDates(java.lang.String effectiveDates) {
    this.effectiveDates = effectiveDates;
    return this;
  }

  /**
   * Optional. The text code that corresponds to the promotion when applied on the retailer?s
   * website.
   * @return value or {@code null} for none
   */
  public java.lang.String getGenericRedemptionCode() {
    return genericRedemptionCode;
  }

  /**
   * Optional. The text code that corresponds to the promotion when applied on the retailer?s
   * website.
   * @param genericRedemptionCode genericRedemptionCode or {@code null} for none
   */
  public OrderLegacyPromotion setGenericRedemptionCode(java.lang.String genericRedemptionCode) {
    this.genericRedemptionCode = genericRedemptionCode;
    return this;
  }

  /**
   * The unique ID of the promotion.
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * The unique ID of the promotion.
   * @param id id or {@code null} for none
   */
  public OrderLegacyPromotion setId(java.lang.String id) {
    this.id = id;
    return this;
  }

  /**
   * The full title of the promotion.
   * @return value or {@code null} for none
   */
  public java.lang.String getLongTitle() {
    return longTitle;
  }

  /**
   * The full title of the promotion.
   * @param longTitle longTitle or {@code null} for none
   */
  public OrderLegacyPromotion setLongTitle(java.lang.String longTitle) {
    this.longTitle = longTitle;
    return this;
  }

  /**
   * Whether the promotion is applicable to all products or only specific products. Acceptable
   * values are: - "`allProducts`" - "`specificProducts`"
   * @return value or {@code null} for none
   */
  public java.lang.String getProductApplicability() {
    return productApplicability;
  }

  /**
   * Whether the promotion is applicable to all products or only specific products. Acceptable
   * values are: - "`allProducts`" - "`specificProducts`"
   * @param productApplicability productApplicability or {@code null} for none
   */
  public OrderLegacyPromotion setProductApplicability(java.lang.String productApplicability) {
    this.productApplicability = productApplicability;
    return this;
  }

  /**
   * Indicates that the promotion is valid online. Acceptable values are: - "`online`"
   * @return value or {@code null} for none
   */
  public java.lang.String getRedemptionChannel() {
    return redemptionChannel;
  }

  /**
   * Indicates that the promotion is valid online. Acceptable values are: - "`online`"
   * @param redemptionChannel redemptionChannel or {@code null} for none
   */
  public OrderLegacyPromotion setRedemptionChannel(java.lang.String redemptionChannel) {
    this.redemptionChannel = redemptionChannel;
    return this;
  }

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

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

}