Package com.google.cloud.retail.v2

Class RemoveLocalInventoriesRequest.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<RemoveLocalInventoriesRequest.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<RemoveLocalInventoriesRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

        public RemoveLocalInventoriesRequest 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<RemoveLocalInventoriesRequest.Builder>

      • mergeFrom

        public RemoveLocalInventoriesRequest.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<RemoveLocalInventoriesRequest.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 RemoveLocalInventoriesRequestOrBuilder
        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 RemoveLocalInventoriesRequestOrBuilder
        Returns:
        The bytes for product.

      • setProduct

        public RemoveLocalInventoriesRequest.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 RemoveLocalInventoriesRequest.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 RemoveLocalInventoriesRequest.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.

      • getPlaceIdsList

        public com.google.protobuf.ProtocolStringList getPlaceIdsList()
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsList in interface RemoveLocalInventoriesRequestOrBuilder
        Returns:
        A list containing the placeIds.

      • getPlaceIdsCount

        public int getPlaceIdsCount()
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsCount in interface RemoveLocalInventoriesRequestOrBuilder
        Returns:
        The count of placeIds.

      • getPlaceIds

        public String getPlaceIds​(int index)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIds in interface RemoveLocalInventoriesRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The placeIds at the given index.

      • getPlaceIdsBytes

        public com.google.protobuf.ByteString getPlaceIdsBytes​(int index)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsBytes in interface RemoveLocalInventoriesRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the placeIds at the given index.

      • setPlaceIds

        public RemoveLocalInventoriesRequest.Builder setPlaceIds​(int index,
                                                         String value)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The placeIds to set.
        Returns:
        This builder for chaining.

      • addPlaceIds

        public RemoveLocalInventoriesRequest.Builder addPlaceIds​(String value)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The placeIds to add.
        Returns:
        This builder for chaining.

      • addAllPlaceIds

        public RemoveLocalInventoriesRequest.Builder addAllPlaceIds​(Iterable<String> values)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The placeIds to add.
        Returns:
        This builder for chaining.

      • clearPlaceIds

        public RemoveLocalInventoriesRequest.Builder clearPlaceIds()
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • addPlaceIdsBytes

        public RemoveLocalInventoriesRequest.Builder addPlaceIdsBytes​(com.google.protobuf.ByteString value)
         Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
        repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes of the placeIds to add.
        Returns:
        This builder for chaining.

      • hasRemoveTime

        public boolean hasRemoveTime()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;
        Specified by:
        hasRemoveTime in interface RemoveLocalInventoriesRequestOrBuilder
        Returns:
        Whether the removeTime field is set.

      • getRemoveTime

        public com.google.protobuf.Timestamp getRemoveTime()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;
        Specified by:
        getRemoveTime in interface RemoveLocalInventoriesRequestOrBuilder
        Returns:
        The removeTime.

      • setRemoveTime

        public RemoveLocalInventoriesRequest.Builder setRemoveTime​(com.google.protobuf.Timestamp value)
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • setRemoveTime

        public RemoveLocalInventoriesRequest.Builder setRemoveTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • mergeRemoveTime

        public RemoveLocalInventoriesRequest.Builder mergeRemoveTime​(com.google.protobuf.Timestamp value)
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • clearRemoveTime

        public RemoveLocalInventoriesRequest.Builder clearRemoveTime()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • getRemoveTimeBuilder

        public com.google.protobuf.Timestamp.Builder getRemoveTimeBuilder()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;

      • getRemoveTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRemoveTimeOrBuilder()
         The time when the inventory deletions are issued. Used to prevent
 out-of-order updates and deletions on local inventory fields. If not
 provided, the internal system time will be used.
        .google.protobuf.Timestamp remove_time = 5;
        Specified by:
        getRemoveTimeOrBuilder in interface RemoveLocalInventoriesRequestOrBuilder

      • getAllowMissing

        public boolean getAllowMissing()
         If set to true, and the [Product][google.cloud.retail.v2.Product] is not
 found, the local inventory removal request 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 = 3;
        Specified by:
        getAllowMissing in interface RemoveLocalInventoriesRequestOrBuilder
        Returns:
        The allowMissing.

      • setAllowMissing

        public RemoveLocalInventoriesRequest.Builder setAllowMissing​(boolean value)
         If set to true, and the [Product][google.cloud.retail.v2.Product] is not
 found, the local inventory removal request 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 = 3;
        Parameters:
        value - The allowMissing to set.
        Returns:
        This builder for chaining.

      • clearAllowMissing

        public RemoveLocalInventoriesRequest.Builder clearAllowMissing()
         If set to true, and the [Product][google.cloud.retail.v2.Product] is not
 found, the local inventory removal request 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 = 3;
        Returns:
        This builder for chaining.