com.google.cloud.retail.v2.SetInventoryRequestOrBuilder 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 SetInventoryRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.SetInventoryRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The inventory information to update. The allowable fields to
   * update are:
   *
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * The updated inventory fields must be specified in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
   *
   * If
   * [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
   * is empty or invalid, an INVALID_ARGUMENT error is returned.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2.Product] named in
   * [Product.name][google.cloud.retail.v2.Product.name], regardless of whether
   * or not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update does not have
   * existing inventory information, the provided inventory information will be
   * inserted.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update has existing
   * inventory information, the provided inventory information will be merged
   * while respecting the last update time for each inventory field, using the
   * provided or default value for
   * [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
   *
   * The caller can replace place IDs for a subset of fulfillment types in the
   * following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types and corresponding place IDs
   * to update in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * The caller can clear all place IDs from a subset of fulfillment types in
   * the following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types to clear in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * * Checks that only the desired fulfillment info types have empty
   * [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
   *
   * The last update time is recorded for the following inventory fields:
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * If a full overwrite of inventory information while ignoring timestamps is
   * needed,
   * [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
   * should be invoked instead.
   * 
   *
   * .google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the inventory field is set.
   */
  boolean hasInventory();
  /**
   *
   *
   *    * Required. The inventory information to update. The allowable fields to
   * update are:
   *
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * The updated inventory fields must be specified in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
   *
   * If
   * [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
   * is empty or invalid, an INVALID_ARGUMENT error is returned.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2.Product] named in
   * [Product.name][google.cloud.retail.v2.Product.name], regardless of whether
   * or not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update does not have
   * existing inventory information, the provided inventory information will be
   * inserted.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update has existing
   * inventory information, the provided inventory information will be merged
   * while respecting the last update time for each inventory field, using the
   * provided or default value for
   * [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
   *
   * The caller can replace place IDs for a subset of fulfillment types in the
   * following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types and corresponding place IDs
   * to update in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * The caller can clear all place IDs from a subset of fulfillment types in
   * the following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types to clear in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * * Checks that only the desired fulfillment info types have empty
   * [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
   *
   * The last update time is recorded for the following inventory fields:
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * If a full overwrite of inventory information while ignoring timestamps is
   * needed,
   * [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
   * should be invoked instead.
   * 
   *
   * .google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The inventory.
   */
  com.google.cloud.retail.v2.Product getInventory();
  /**
   *
   *
   *    * Required. The inventory information to update. The allowable fields to
   * update are:
   *
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * The updated inventory fields must be specified in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
   *
   * If
   * [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
   * is empty or invalid, an INVALID_ARGUMENT error is returned.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2.Product] named in
   * [Product.name][google.cloud.retail.v2.Product.name], regardless of whether
   * or not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update does not have
   * existing inventory information, the provided inventory information will be
   * inserted.
   *
   * If the [Product][google.cloud.retail.v2.Product] to update has existing
   * inventory information, the provided inventory information will be merged
   * while respecting the last update time for each inventory field, using the
   * provided or default value for
   * [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
   *
   * The caller can replace place IDs for a subset of fulfillment types in the
   * following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types and corresponding place IDs
   * to update in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * The caller can clear all place IDs from a subset of fulfillment types in
   * the following ways:
   *
   * * Adds "fulfillment_info" in
   * [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask]
   * * Specifies only the desired fulfillment types to clear in
   * [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   * * Checks that only the desired fulfillment info types have empty
   * [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
   *
   * The last update time is recorded for the following inventory fields:
   * * [Product.price_info][google.cloud.retail.v2.Product.price_info]
   * * [Product.availability][google.cloud.retail.v2.Product.availability]
   * * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
   * * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
   *
   * If a full overwrite of inventory information while ignoring timestamps is
   * needed,
   * [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
   * should be invoked instead.
   * 
   *
   * .google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.retail.v2.ProductOrBuilder getInventoryOrBuilder();

  /**
   *
   *
   *    * Indicates which inventory fields in the provided
   * [Product][google.cloud.retail.v2.Product] to update.
   *
   * At least one field must be provided.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned and the entire update will be ignored.
   * 
   *
   * .google.protobuf.FieldMask set_mask = 2;
   *
   * @return Whether the setMask field is set.
   */
  boolean hasSetMask();
  /**
   *
   *
   *    * Indicates which inventory fields in the provided
   * [Product][google.cloud.retail.v2.Product] to update.
   *
   * At least one field must be provided.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned and the entire update will be ignored.
   * 
   *
   * .google.protobuf.FieldMask set_mask = 2;
   *
   * @return The setMask.
   */
  com.google.protobuf.FieldMask getSetMask();
  /**
   *
   *
   *    * Indicates which inventory fields in the provided
   * [Product][google.cloud.retail.v2.Product] to update.
   *
   * At least one field must be provided.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned and the entire update will be ignored.
   * 
   *
   * .google.protobuf.FieldMask set_mask = 2;
   */
  com.google.protobuf.FieldMaskOrBuilder getSetMaskOrBuilder();

  /**
   *
   *
   *    * The time when the request is issued, used to prevent
   * out-of-order updates on inventory fields with the last update time
   * recorded. If not provided, the internal system time will be used.
   * 
   *
   * .google.protobuf.Timestamp set_time = 3;
   *
   * @return Whether the setTime field is set.
   */
  boolean hasSetTime();
  /**
   *
   *
   *    * The time when the request is issued, used to prevent
   * out-of-order updates on inventory fields with the last update time
   * recorded. If not provided, the internal system time will be used.
   * 
   *
   * .google.protobuf.Timestamp set_time = 3;
   *
   * @return The setTime.
   */
  com.google.protobuf.Timestamp getSetTime();
  /**
   *
   *
   *    * The time when the request is issued, used to prevent
   * out-of-order updates on inventory fields with the last update time
   * recorded. If not provided, the internal system time will be used.
   * 
   *
   * .google.protobuf.Timestamp set_time = 3;
   */
  com.google.protobuf.TimestampOrBuilder getSetTimeOrBuilder();

  /**
   *
   *
   *    * If set to true, and the [Product][google.cloud.retail.v2.Product] with name
   * [Product.name][google.cloud.retail.v2.Product.name] is not found, the
   * inventory update will still be processed and retained for at most 1 day
   * until 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 = 4;
   *
   * @return The allowMissing.
   */
  boolean getAllowMissing();
}