Package com.google.cloud.retail.v2

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

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

      • setProduct

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

      • getType

        public String getType()
         Required. The fulfillment type, including commonly used types (such as
 pickup in store and same day delivery), and custom types.

 Supported values:

 * "pickup-in-store"
 * "ship-to-store"
 * "same-day-delivery"
 * "next-day-delivery"
 * "custom-type-1"
 * "custom-type-2"
 * "custom-type-3"
 * "custom-type-4"
 * "custom-type-5"

 If this field is set to an invalid value other than these, an
 INVALID_ARGUMENT error is returned.

 This field directly corresponds to
 [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getType in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         Required. The fulfillment type, including commonly used types (such as
 pickup in store and same day delivery), and custom types.

 Supported values:

 * "pickup-in-store"
 * "ship-to-store"
 * "same-day-delivery"
 * "next-day-delivery"
 * "custom-type-1"
 * "custom-type-2"
 * "custom-type-3"
 * "custom-type-4"
 * "custom-type-5"

 If this field is set to an invalid value other than these, an
 INVALID_ARGUMENT error is returned.

 This field directly corresponds to
 [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTypeBytes in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        The bytes for type.

      • setType

        public AddFulfillmentPlacesRequest.Builder setType​(String value)
         Required. The fulfillment type, including commonly used types (such as
 pickup in store and same day delivery), and custom types.

 Supported values:

 * "pickup-in-store"
 * "ship-to-store"
 * "same-day-delivery"
 * "next-day-delivery"
 * "custom-type-1"
 * "custom-type-2"
 * "custom-type-3"
 * "custom-type-4"
 * "custom-type-5"

 If this field is set to an invalid value other than these, an
 INVALID_ARGUMENT error is returned.

 This field directly corresponds to
 [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public AddFulfillmentPlacesRequest.Builder clearType()
         Required. The fulfillment type, including commonly used types (such as
 pickup in store and same day delivery), and custom types.

 Supported values:

 * "pickup-in-store"
 * "ship-to-store"
 * "same-day-delivery"
 * "next-day-delivery"
 * "custom-type-1"
 * "custom-type-2"
 * "custom-type-3"
 * "custom-type-4"
 * "custom-type-5"

 If this field is set to an invalid value other than these, an
 INVALID_ARGUMENT error is returned.

 This field directly corresponds to
 [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setTypeBytes

        public AddFulfillmentPlacesRequest.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         Required. The fulfillment type, including commonly used types (such as
 pickup in store and same day delivery), and custom types.

 Supported values:

 * "pickup-in-store"
 * "ship-to-store"
 * "same-day-delivery"
 * "next-day-delivery"
 * "custom-type-1"
 * "custom-type-2"
 * "custom-type-3"
 * "custom-type-4"
 * "custom-type-5"

 If this field is set to an invalid value other than these, an
 INVALID_ARGUMENT error is returned.

 This field directly corresponds to
 [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

      • getPlaceIdsList

        public com.google.protobuf.ProtocolStringList getPlaceIdsList()
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsList in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        A list containing the placeIds.

      • getPlaceIdsCount

        public int getPlaceIdsCount()
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsCount in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        The count of placeIds.

      • getPlaceIds

        public String getPlaceIds​(int index)
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIds in interface AddFulfillmentPlacesRequestOrBuilder
        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. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaceIdsBytes in interface AddFulfillmentPlacesRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the placeIds at the given index.

      • setPlaceIds

        public AddFulfillmentPlacesRequest.Builder setPlaceIds​(int index,
                                                       String value)
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.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 AddFulfillmentPlacesRequest.Builder addPlaceIds​(String value)
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The placeIds to add.
        Returns:
        This builder for chaining.

      • addAllPlaceIds

        public AddFulfillmentPlacesRequest.Builder addAllPlaceIds​(Iterable<String> values)
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The placeIds to add.
        Returns:
        This builder for chaining.

      • clearPlaceIds

        public AddFulfillmentPlacesRequest.Builder clearPlaceIds()
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • addPlaceIdsBytes

        public AddFulfillmentPlacesRequest.Builder addPlaceIdsBytes​(com.google.protobuf.ByteString value)
         Required. The IDs for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as
 the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate
 IDs will be automatically ignored.

 At least 1 value is required, and a maximum of 2000 values are allowed.
 Each value must be a string with a length limit of 10 characters, matching
 the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
 INVALID_ARGUMENT error is returned.

 If the total number of place IDs exceeds 2000 for this
 [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
        repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes of the placeIds to add.
        Returns:
        This builder for chaining.

      • hasAddTime

        public boolean hasAddTime()
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;
        Specified by:
        hasAddTime in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        Whether the addTime field is set.

      • getAddTime

        public com.google.protobuf.Timestamp getAddTime()
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;
        Specified by:
        getAddTime in interface AddFulfillmentPlacesRequestOrBuilder
        Returns:
        The addTime.

      • setAddTime

        public AddFulfillmentPlacesRequest.Builder setAddTime​(com.google.protobuf.Timestamp value)
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;

      • setAddTime

        public AddFulfillmentPlacesRequest.Builder setAddTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;

      • mergeAddTime

        public AddFulfillmentPlacesRequest.Builder mergeAddTime​(com.google.protobuf.Timestamp value)
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;

      • clearAddTime

        public AddFulfillmentPlacesRequest.Builder clearAddTime()
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;

      • getAddTimeBuilder

        public com.google.protobuf.Timestamp.Builder getAddTimeBuilder()
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;

      • getAddTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getAddTimeOrBuilder()
         The time when the fulfillment updates are issued, used to prevent
 out-of-order updates on fulfillment information. If not provided, the
 internal system time will be used.
        .google.protobuf.Timestamp add_time = 4;
        Specified by:
        getAddTimeOrBuilder in interface AddFulfillmentPlacesRequestOrBuilder

      • getAllowMissing

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

      • setAllowMissing

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

      • clearAllowMissing

        public AddFulfillmentPlacesRequest.Builder clearAllowMissing()
         If set to true, and the [Product][google.cloud.retail.v2.Product] is not
 found, the fulfillment information 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 = 5;
        Returns:
        This builder for chaining.

      • mergeUnknownFields

        public final AddFulfillmentPlacesRequest.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<AddFulfillmentPlacesRequest.Builder>