Package com.google.cloud.retail.v2alpha

Class AddLocalInventoriesRequest

  • All Implemented Interfaces:
    AddLocalInventoriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AddLocalInventoriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements AddLocalInventoriesRequestOrBuilder
     Request message for
 [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories]
 method.
    Protobuf type google.cloud.retail.v2alpha.AddLocalInventoriesRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getProduct

        public String getProduct()
         Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.

      • 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.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocalInventoriesList 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.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocalInventoriesOrBuilderList 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.v2alpha.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.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocalInventories in interface AddLocalInventoriesRequestOrBuilder

      • 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.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLocalInventoriesOrBuilder in interface AddLocalInventoriesRequestOrBuilder

      • hasAddMask

        public boolean hasAddMask()
         Indicates which inventory fields in the provided list of
 [LocalInventory][google.cloud.retail.v2alpha.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.v2alpha.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.

      • getAddMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getAddMaskOrBuilder()
         Indicates which inventory fields in the provided list of
 [LocalInventory][google.cloud.retail.v2alpha.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.

      • 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.v2alpha.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.v2alpha.Product] is created. If set to false,
 a NOT_FOUND error is returned if the
 [Product][google.cloud.retail.v2alpha.Product] is not found.
        bool allow_missing = 6;
        Specified by:
        getAllowMissing in interface AddLocalInventoriesRequestOrBuilder
        Returns:
        The allowMissing.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AddLocalInventoriesRequest parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected AddLocalInventoriesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AddLocalInventoriesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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