com.google.cloud.retail.v2.AddLocalInventoriesRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/product_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface AddLocalInventoriesRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.AddLocalInventoriesRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
   * such as
   * `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *
   * If the caller does not have permission to access the
   * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
   * exists, a PERMISSION_DENIED error is returned.
   * 
   *
   * 
   * string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The product.
   */
  java.lang.String getProduct();
  /**
   *
   *
   *    * Required. Full resource name of [Product][google.cloud.retail.v2.Product],
   * such as
   * `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *
   * If the caller does not have permission to access the
   * [Product][google.cloud.retail.v2.Product], regardless of whether or not it
   * exists, a PERMISSION_DENIED error is returned.
   * 
   *
   * 
   * string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for product.
   */
  com.google.protobuf.ByteString getProductBytes();

  /**
   *
   *
   *    * 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.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List getLocalInventoriesList();
  /**
   *
   *
   *    * 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.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.retail.v2.LocalInventory getLocalInventories(int index);
  /**
   *
   *
   *    * 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.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  int getLocalInventoriesCount();
  /**
   *
   *
   *    * 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.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List
      getLocalInventoriesOrBuilderList();
  /**
   *
   *
   *    * 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.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.retail.v2.LocalInventoryOrBuilder getLocalInventoriesOrBuilder(int index);

  /**
   *
   *
   *    * Indicates which inventory fields in the provided list of
   * [LocalInventory][google.cloud.retail.v2.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.
   * 
   *
   * .google.protobuf.FieldMask add_mask = 4;
   *
   * @return Whether the addMask field is set.
   */
  boolean hasAddMask();
  /**
   *
   *
   *    * Indicates which inventory fields in the provided list of
   * [LocalInventory][google.cloud.retail.v2.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.
   * 
   *
   * .google.protobuf.FieldMask add_mask = 4;
   *
   * @return The addMask.
   */
  com.google.protobuf.FieldMask getAddMask();
  /**
   *
   *
   *    * Indicates which inventory fields in the provided list of
   * [LocalInventory][google.cloud.retail.v2.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.
   * 
   *
   * .google.protobuf.FieldMask add_mask = 4;
   */
  com.google.protobuf.FieldMaskOrBuilder getAddMaskOrBuilder();

  /**
   *
   *
   *    * 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.
   * 
   *
   * .google.protobuf.Timestamp add_time = 5;
   *
   * @return Whether the addTime field is set.
   */
  boolean hasAddTime();
  /**
   *
   *
   *    * 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.
   * 
   *
   * .google.protobuf.Timestamp add_time = 5;
   *
   * @return The addTime.
   */
  com.google.protobuf.Timestamp getAddTime();
  /**
   *
   *
   *    * 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.
   * 
   *
   * .google.protobuf.Timestamp add_time = 5;
   */
  com.google.protobuf.TimestampOrBuilder getAddTimeOrBuilder();

  /**
   *
   *
   *    * If set to true, and the [Product][google.cloud.retail.v2.Product] is not
   * found, the local inventory will still be processed and retained for at most
   * 1 day and processed once the [Product][google.cloud.retail.v2.Product] is
   * created. If set to false, a NOT_FOUND error is returned if the
   * [Product][google.cloud.retail.v2.Product] is not found.
   * 
   *
   * bool allow_missing = 6;
   *
   * @return The allowMissing.
   */
  boolean getAllowMissing();
}