com.google.api.services.retail.v2.model.GoogleCloudRetailV2Promotion Maven / Gradle / Ivy

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

/**
 * Promotion specification.
 *
 *  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 Vertex AI Search for Retail 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 GoogleCloudRetailV2Promotion extends com.google.api.client.json.GenericJson {

  /**
   * Promotion identifier, which is the final component of name. For example, this field is
   * "free_gift", if name is
   * `projects/locations/global/catalogs/default_catalog/promotions/free_gift`. The value must be a
   * UTF-8 encoded string with a length limit of 128 characters, and match the pattern: `a-zA-Z*`.
   * For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned.
   * Corresponds to Google Merchant Center property
   * [promotion_id](https://support.google.com/merchants/answer/7050148).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String promotionId;

  /**
   * Promotion identifier, which is the final component of name. For example, this field is
   * "free_gift", if name is
   * `projects/locations/global/catalogs/default_catalog/promotions/free_gift`. The value must be a
   * UTF-8 encoded string with a length limit of 128 characters, and match the pattern: `a-zA-Z*`.
   * For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned.
   * Corresponds to Google Merchant Center property
   * [promotion_id](https://support.google.com/merchants/answer/7050148).
   * @return value or {@code null} for none
   */
  public java.lang.String getPromotionId() {
    return promotionId;
  }

  /**
   * Promotion identifier, which is the final component of name. For example, this field is
   * "free_gift", if name is
   * `projects/locations/global/catalogs/default_catalog/promotions/free_gift`. The value must be a
   * UTF-8 encoded string with a length limit of 128 characters, and match the pattern: `a-zA-Z*`.
   * For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned.
   * Corresponds to Google Merchant Center property
   * [promotion_id](https://support.google.com/merchants/answer/7050148).
   * @param promotionId promotionId or {@code null} for none
   */
  public GoogleCloudRetailV2Promotion setPromotionId(java.lang.String promotionId) {
    this.promotionId = promotionId;
    return this;
  }

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

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

}