Package com.google.cloud.retail.v2alpha

Class RemoveFulfillmentPlacesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest
All Implemented Interfaces:
RemoveFulfillmentPlacesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RemoveFulfillmentPlacesRequest extends com.google.protobuf.GeneratedMessage implements RemoveFulfillmentPlacesRequestOrBuilder
 Request message for
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces]
 method.
Protobuf type google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest
See Also:

  • Field Details

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 RemoveFulfillmentPlacesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RemoveFulfillmentPlacesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RemoveFulfillmentPlacesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RemoveFulfillmentPlacesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RemoveFulfillmentPlacesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RemoveFulfillmentPlacesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RemoveFulfillmentPlacesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RemoveFulfillmentPlacesRequest.Builder newBuilder()

    • newBuilder

      public static RemoveFulfillmentPlacesRequest.Builder newBuilder(RemoveFulfillmentPlacesRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected RemoveFulfillmentPlacesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RemoveFulfillmentPlacesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RemoveFulfillmentPlacesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RemoveFulfillmentPlacesRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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