com.google.api.services.retail.v2.model.GoogleCloudRetailV2AddLocalInventoriesRequest 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;

/**
 * Request message for ProductService.AddLocalInventories method.
 *
 *  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 GoogleCloudRetailV2AddLocalInventoriesRequest extends com.google.api.client.json.GenericJson {

  /**
   * Indicates which inventory fields in the provided list of LocalInventory to update. The field is
   * updated to the provided value. If a field is set while the place does not have a previous local
   * inventory, the local inventory at that store is created. If a field is set while the value of
   * that field is not provided, the original field value, if it exists, is deleted. If the mask is
   * not set or set with empty paths, all inventory fields will be updated. If an unsupported or
   * unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be
   * ignored.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String addMask;

  /**
   * The time when the inventory updates are issued. Used to prevent out-of-order updates on local
   * inventory fields. If not provided, the internal system time will be used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String addTime;

  /**
   * If set to true, and the Product is not found, the local inventory will still be processed and
   * retained for at most 1 day and processed once the Product is created. If set to false, a
   * NOT_FOUND error is returned if the Product is not found.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean allowMissing;

  /**
   * Required. A list of inventory information at difference places. Each place is identified by its
   * place ID. At most 3000 inventories are allowed per request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List localInventories;

  /**
   * Indicates which inventory fields in the provided list of LocalInventory to update. The field is
   * updated to the provided value. If a field is set while the place does not have a previous local
   * inventory, the local inventory at that store is created. If a field is set while the value of
   * that field is not provided, the original field value, if it exists, is deleted. If the mask is
   * not set or set with empty paths, all inventory fields will be updated. If an unsupported or
   * unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be
   * ignored.
   * @return value or {@code null} for none
   */
  public String getAddMask() {
    return addMask;
  }

  /**
   * Indicates which inventory fields in the provided list of LocalInventory to update. The field is
   * updated to the provided value. If a field is set while the place does not have a previous local
   * inventory, the local inventory at that store is created. If a field is set while the value of
   * that field is not provided, the original field value, if it exists, is deleted. If the mask is
   * not set or set with empty paths, all inventory fields will be updated. If an unsupported or
   * unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be
   * ignored.
   * @param addMask addMask or {@code null} for none
   */
  public GoogleCloudRetailV2AddLocalInventoriesRequest setAddMask(String addMask) {
    this.addMask = addMask;
    return this;
  }

  /**
   * The time when the inventory updates are issued. Used to prevent out-of-order updates on local
   * inventory fields. If not provided, the internal system time will be used.
   * @return value or {@code null} for none
   */
  public String getAddTime() {
    return addTime;
  }

  /**
   * The time when the inventory updates are issued. Used to prevent out-of-order updates on local
   * inventory fields. If not provided, the internal system time will be used.
   * @param addTime addTime or {@code null} for none
   */
  public GoogleCloudRetailV2AddLocalInventoriesRequest setAddTime(String addTime) {
    this.addTime = addTime;
    return this;
  }

  /**
   * If set to true, and the Product is not found, the local inventory will still be processed and
   * retained for at most 1 day and processed once the Product is created. If set to false, a
   * NOT_FOUND error is returned if the Product is not found.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getAllowMissing() {
    return allowMissing;
  }

  /**
   * If set to true, and the Product is not found, the local inventory will still be processed and
   * retained for at most 1 day and processed once the Product is created. If set to false, a
   * NOT_FOUND error is returned if the Product is not found.
   * @param allowMissing allowMissing or {@code null} for none
   */
  public GoogleCloudRetailV2AddLocalInventoriesRequest setAllowMissing(java.lang.Boolean allowMissing) {
    this.allowMissing = allowMissing;
    return this;
  }

  /**
   * Required. A list of inventory information at difference places. Each place is identified by its
   * place ID. At most 3000 inventories are allowed per request.
   * @return value or {@code null} for none
   */
  public java.util.List getLocalInventories() {
    return localInventories;
  }

  /**
   * Required. A list of inventory information at difference places. Each place is identified by its
   * place ID. At most 3000 inventories are allowed per request.
   * @param localInventories localInventories or {@code null} for none
   */
  public GoogleCloudRetailV2AddLocalInventoriesRequest setLocalInventories(java.util.List localInventories) {
    this.localInventories = localInventories;
    return this;
  }

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

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

}