Package com.google.cloud.retail.v2

Class AddLocalInventoriesRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AddLocalInventoriesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AddLocalInventoriesRequest.Builder>

      • getDefaultInstanceForType

        public AddLocalInventoriesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public AddLocalInventoriesRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public AddLocalInventoriesRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AddLocalInventoriesRequest.Builder>

      • mergeFrom

        public AddLocalInventoriesRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AddLocalInventoriesRequest.Builder>
        Throws:
        IOException

      • getProduct

        public 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) = { ... }
        Specified by:
        getProduct in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The product.

      • getProductBytes

        public 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) = { ... }
        Specified by:
        getProductBytes in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The bytes for product.

      • setProduct

        public AddLocalInventoriesRequest.Builder setProduct​(String value)
         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) = { ... }
        Parameters:
        value - The product to set.
        Returns:
        This builder for chaining.

      • clearProduct

        public AddLocalInventoriesRequest.Builder clearProduct()
         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:
        This builder for chaining.

      • setProductBytes

        public AddLocalInventoriesRequest.Builder setProductBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for product to set.
        Returns:
        This builder for chaining.

      • getLocalInventoriesList

        public 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];
        Specified by:
        getLocalInventoriesList in interface AddLocalInventoriesRequestOrBuilder

      • getLocalInventoriesCount

        public 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];
        Specified by:
        getLocalInventoriesCount in interface AddLocalInventoriesRequestOrBuilder

      • getLocalInventories

        public 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];
        Specified by:
        getLocalInventories in interface AddLocalInventoriesRequestOrBuilder

      • setLocalInventories

        public AddLocalInventoriesRequest.Builder setLocalInventories​(int index,
                                                              LocalInventory value)
         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];

      • setLocalInventories

        public AddLocalInventoriesRequest.Builder setLocalInventories​(int index,
                                                              LocalInventory.Builder builderForValue)
         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];

      • addLocalInventories

        public AddLocalInventoriesRequest.Builder addLocalInventories​(LocalInventory value)
         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];

      • addLocalInventories

        public AddLocalInventoriesRequest.Builder addLocalInventories​(int index,
                                                              LocalInventory value)
         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];

      • addLocalInventories

        public AddLocalInventoriesRequest.Builder addLocalInventories​(LocalInventory.Builder builderForValue)
         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];

      • addLocalInventories

        public AddLocalInventoriesRequest.Builder addLocalInventories​(int index,
                                                              LocalInventory.Builder builderForValue)
         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];

      • addAllLocalInventories

        public AddLocalInventoriesRequest.Builder addAllLocalInventories​(Iterable<? extends LocalInventory> values)
         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];

      • clearLocalInventories

        public AddLocalInventoriesRequest.Builder clearLocalInventories()
         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];

      • removeLocalInventories

        public AddLocalInventoriesRequest.Builder removeLocalInventories​(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];

      • getLocalInventoriesBuilder

        public LocalInventory.Builder getLocalInventoriesBuilder​(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];

      • getLocalInventoriesOrBuilder

        public 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];
        Specified by:
        getLocalInventoriesOrBuilder in interface AddLocalInventoriesRequestOrBuilder

      • getLocalInventoriesOrBuilderList

        public 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];
        Specified by:
        getLocalInventoriesOrBuilderList in interface AddLocalInventoriesRequestOrBuilder

      • addLocalInventoriesBuilder

        public LocalInventory.Builder addLocalInventoriesBuilder()
         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];

      • addLocalInventoriesBuilder

        public LocalInventory.Builder addLocalInventoriesBuilder​(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];

      • getLocalInventoriesBuilderList

        public List<LocalInventory.Builder> getLocalInventoriesBuilderList()
         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

        public 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;
        Specified by:
        hasAddMask in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        Whether the addMask field is set.

      • getAddMask

        public 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;
        Specified by:
        getAddMask in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The addMask.

      • setAddMask

        public AddLocalInventoriesRequest.Builder setAddMask​(com.google.protobuf.FieldMask value)
         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;

      • setAddMask

        public AddLocalInventoriesRequest.Builder setAddMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         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;

      • mergeAddMask

        public AddLocalInventoriesRequest.Builder mergeAddMask​(com.google.protobuf.FieldMask value)
         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;

      • clearAddMask

        public AddLocalInventoriesRequest.Builder clearAddMask()
         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;

      • getAddMaskBuilder

        public com.google.protobuf.FieldMask.Builder getAddMaskBuilder()
         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;

      • getAddMaskOrBuilder

        public 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;
        Specified by:
        getAddMaskOrBuilder in interface AddLocalInventoriesRequestOrBuilder

      • hasAddTime

        public 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;
        Specified by:
        hasAddTime in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        Whether the addTime field is set.

      • getAddTime

        public 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;
        Specified by:
        getAddTime in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The addTime.

      • setAddTime

        public AddLocalInventoriesRequest.Builder setAddTime​(com.google.protobuf.Timestamp value)
         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;

      • setAddTime

        public AddLocalInventoriesRequest.Builder setAddTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         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;

      • mergeAddTime

        public AddLocalInventoriesRequest.Builder mergeAddTime​(com.google.protobuf.Timestamp value)
         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;

      • clearAddTime

        public AddLocalInventoriesRequest.Builder clearAddTime()
         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;

      • getAddTimeBuilder

        public com.google.protobuf.Timestamp.Builder getAddTimeBuilder()
         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;

      • getAddTimeOrBuilder

        public 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;
        Specified by:
        getAddTimeOrBuilder in interface AddLocalInventoriesRequestOrBuilder

      • getAllowMissing

        public 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;
        Specified by:
        getAllowMissing in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The allowMissing.

      • setAllowMissing

        public AddLocalInventoriesRequest.Builder setAllowMissing​(boolean value)
         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;
        Parameters:
        value - The allowMissing to set.
        Returns:
        This builder for chaining.

      • clearAllowMissing

        public AddLocalInventoriesRequest.Builder clearAllowMissing()
         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:
        This builder for chaining.

      • setUnknownFields

        public final AddLocalInventoriesRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AddLocalInventoriesRequest.Builder>

      • mergeUnknownFields

        public final AddLocalInventoriesRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AddLocalInventoriesRequest.Builder>