Class RemoveFulfillmentPlacesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.Builder>
com.google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.Builder
All Implemented Interfaces:
RemoveFulfillmentPlacesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RemoveFulfillmentPlacesRequest

public static final class RemoveFulfillmentPlacesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.Builder> implements RemoveFulfillmentPlacesRequestOrBuilder
 Request message for
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces]
 method.
 
Protobuf type google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.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.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.Builder>
    • getDefaultInstanceForType

      public RemoveFulfillmentPlacesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

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

      public RemoveFulfillmentPlacesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RemoveFulfillmentPlacesRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RemoveFulfillmentPlacesRequest.Builder>
    • mergeFrom

      public RemoveFulfillmentPlacesRequest.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<RemoveFulfillmentPlacesRequest.Builder>
      Throws:
      IOException
    • 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 RemoveFulfillmentPlacesRequestOrBuilder
      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 RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      The bytes for product.
    • setProduct

       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) = { ... }
      Parameters:
      value - The product to set.
      Returns:
      This builder for chaining.
    • clearProduct

       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) = { ... }
      Returns:
      This builder for chaining.
    • setProductBytes

      public RemoveFulfillmentPlacesRequest.Builder setProductBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      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.v2alpha.FulfillmentInfo.type].
       
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getType in interface RemoveFulfillmentPlacesRequestOrBuilder
      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.v2alpha.FulfillmentInfo.type].
       
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTypeBytes in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      The bytes for type.
    • setType

       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.v2alpha.FulfillmentInfo.type].
       
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.
    • 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.v2alpha.FulfillmentInfo.type].
       
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setTypeBytes

      public RemoveFulfillmentPlacesRequest.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.v2alpha.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.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaceIdsList in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      A list containing the placeIds.
    • getPlaceIdsCount

      public int getPlaceIdsCount()
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaceIdsCount in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      The count of placeIds.
    • getPlaceIds

      public String getPlaceIds(int index)
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaceIds in interface RemoveFulfillmentPlacesRequestOrBuilder
      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.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlaceIdsBytes in interface RemoveFulfillmentPlacesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the placeIds at the given index.
    • setPlaceIds

      public RemoveFulfillmentPlacesRequest.Builder setPlaceIds(int index, String value)
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      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 RemoveFulfillmentPlacesRequest.Builder addPlaceIds(String value)
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The placeIds to add.
      Returns:
      This builder for chaining.
    • addAllPlaceIds

      public RemoveFulfillmentPlacesRequest.Builder addAllPlaceIds(Iterable<String> values)
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      values - The placeIds to add.
      Returns:
      This builder for chaining.
    • clearPlaceIds

       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • addPlaceIdsBytes

      public RemoveFulfillmentPlacesRequest.Builder addPlaceIdsBytes(com.google.protobuf.ByteString value)
       Required. The IDs for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type],
       such as the store IDs for "pickup-in-store" or the region IDs for
       "same-day-delivery", to be removed for this
       [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
      
       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.
       
      repeated string place_ids = 3 [(.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 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 remove_time = 4;
      Specified by:
      hasRemoveTime in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      Whether the removeTime field is set.
    • getRemoveTime

      public com.google.protobuf.Timestamp getRemoveTime()
       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 remove_time = 4;
      Specified by:
      getRemoveTime in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      The removeTime.
    • setRemoveTime

      public RemoveFulfillmentPlacesRequest.Builder setRemoveTime(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 remove_time = 4;
    • setRemoveTime

      public RemoveFulfillmentPlacesRequest.Builder setRemoveTime(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 remove_time = 4;
    • mergeRemoveTime

      public RemoveFulfillmentPlacesRequest.Builder mergeRemoveTime(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 remove_time = 4;
    • clearRemoveTime

      public RemoveFulfillmentPlacesRequest.Builder clearRemoveTime()
       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 remove_time = 4;
    • getRemoveTimeBuilder

      public com.google.protobuf.Timestamp.Builder getRemoveTimeBuilder()
       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 remove_time = 4;
    • getRemoveTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getRemoveTimeOrBuilder()
       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 remove_time = 4;
      Specified by:
      getRemoveTimeOrBuilder in interface RemoveFulfillmentPlacesRequestOrBuilder
    • getAllowMissing

      public boolean getAllowMissing()
       If set to true, and the [Product][google.cloud.retail.v2alpha.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.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 = 5;
      Specified by:
      getAllowMissing in interface RemoveFulfillmentPlacesRequestOrBuilder
      Returns:
      The allowMissing.
    • setAllowMissing

      public RemoveFulfillmentPlacesRequest.Builder setAllowMissing(boolean value)
       If set to true, and the [Product][google.cloud.retail.v2alpha.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.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 = 5;
      Parameters:
      value - The allowMissing to set.
      Returns:
      This builder for chaining.
    • clearAllowMissing

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