Package com.google.cloud.retail.v2

Interface AddLocalInventoriesRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.FieldMask getAddMask()
      Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
      com.google.protobuf.FieldMaskOrBuilder getAddMaskOrBuilder()
      Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
      com.google.protobuf.Timestamp getAddTime()
      The time when the inventory updates are issued.
      com.google.protobuf.TimestampOrBuilder getAddTimeOrBuilder()
      The time when the inventory updates are issued.
      boolean getAllowMissing()
      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.
      LocalInventory getLocalInventories​(int index)
      Required.
      int getLocalInventoriesCount()
      Required.
      List<LocalInventory> getLocalInventoriesList()
      Required.
      LocalInventoryOrBuilder getLocalInventoriesOrBuilder​(int index)
      Required.
      List<? extends LocalInventoryOrBuilder> getLocalInventoriesOrBuilderList()
      Required.
      String getProduct()
      Required.
      com.google.protobuf.ByteString getProductBytes()
      Required.
      boolean hasAddMask()
      Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
      boolean hasAddTime()
      The time when the inventory updates are issued.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getProduct

        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) = { ... }
        Returns:
        The product.

      • getProductBytes

        com.google.protobuf.ByteString getProductBytes()
         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) = { ... }
        Returns:
        The bytes for product.

      • getLocalInventoriesList

        List<LocalInventory> 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];

      • getLocalInventories

        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];

      • getLocalInventoriesCount

        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];

      • getLocalInventoriesOrBuilderList

        List<? extends LocalInventoryOrBuilder> 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];

      • getLocalInventoriesOrBuilder

        LocalInventoryOrBuilder getLocalInventoriesOrBuilder​(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];

      • hasAddMask

        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;
        Returns:
        Whether the addMask field is set.

      • getAddMask

        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;
        Returns:
        The addMask.

      • getAddMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getAddMaskOrBuilder()
         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;

      • hasAddTime

        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;
        Returns:
        Whether the addTime field is set.

      • getAddTime

        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;
        Returns:
        The addTime.

      • getAddTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getAddTimeOrBuilder()
         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;

      • getAllowMissing

        boolean getAllowMissing()
         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;
        Returns:
        The allowMissing.