Class AddFulfillmentPlacesRequest.Builder (2.51.0) 

public static final class AddFulfillmentPlacesRequest.Builder extends GeneratedMessageV3.Builder<AddFulfillmentPlacesRequest.Builder> implements AddFulfillmentPlacesRequestOrBuilder

Request message for ProductService.AddFulfillmentPlaces method.

Protobuf type google.cloud.retail.v2alpha.AddFulfillmentPlacesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AddFulfillmentPlacesRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPlaceIds(Iterable<String> values)

public AddFulfillmentPlacesRequest.Builder addAllPlaceIds(Iterable<String> values)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The placeIds to add.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

addPlaceIds(String value)

public AddFulfillmentPlacesRequest.Builder addPlaceIds(String value)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The placeIds to add.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

addPlaceIdsBytes(ByteString value)

public AddFulfillmentPlacesRequest.Builder addPlaceIdsBytes(ByteString value)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the placeIds to add.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AddFulfillmentPlacesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

build()

public AddFulfillmentPlacesRequest build()
Returns
Type Description
AddFulfillmentPlacesRequest

buildPartial()

public AddFulfillmentPlacesRequest buildPartial()
Returns
Type Description
AddFulfillmentPlacesRequest

clear()

public AddFulfillmentPlacesRequest.Builder clear()
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

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;

Returns
Type Description
AddFulfillmentPlacesRequest.Builder

clearAllowMissing()

public AddFulfillmentPlacesRequest.Builder clearAllowMissing()

If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 5;

Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AddFulfillmentPlacesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AddFulfillmentPlacesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

clearPlaceIds()

public AddFulfillmentPlacesRequest.Builder clearPlaceIds()

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

clearProduct()

public AddFulfillmentPlacesRequest.Builder clearProduct()

Required. Full resource name of 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, 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
Type Description
AddFulfillmentPlacesRequest.Builder

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.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

clone()

public AddFulfillmentPlacesRequest.Builder clone()
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

getAddTime()

public 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;

Returns
Type Description
Timestamp

The addTime.

getAddTimeBuilder()

public 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;

Returns
Type Description
Builder

getAddTimeOrBuilder()

public 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;

Returns
Type Description
TimestampOrBuilder

getAllowMissing()

public boolean getAllowMissing()

If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 5;

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public AddFulfillmentPlacesRequest getDefaultInstanceForType()
Returns
Type Description
AddFulfillmentPlacesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPlaceIds(int index)

public String getPlaceIds(int index)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The placeIds at the given index.

getPlaceIdsBytes(int index)

public ByteString getPlaceIdsBytes(int index)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the placeIds at the given index.

getPlaceIdsCount()

public int getPlaceIdsCount()

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of placeIds.

getPlaceIdsList()

public ProtocolStringList getPlaceIdsList()

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the placeIds.

getProduct()

public String getProduct()

Required. Full resource name of 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, 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
Type Description
String

The product.

getProductBytes()

public ByteString getProductBytes()

Required. Full resource name of 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, 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
Type Description
ByteString

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.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The type.

getTypeBytes()

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

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for type.

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;

Returns
Type Description
boolean

Whether the addTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAddTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

mergeFrom(AddFulfillmentPlacesRequest other)

public AddFulfillmentPlacesRequest.Builder mergeFrom(AddFulfillmentPlacesRequest other)
Parameter
Name Description
other AddFulfillmentPlacesRequest
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AddFulfillmentPlacesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AddFulfillmentPlacesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AddFulfillmentPlacesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

setAddTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

setAddTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

setAllowMissing(boolean value)

public AddFulfillmentPlacesRequest.Builder setAllowMissing(boolean value)

If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 5;

Parameter
Name Description
value boolean

The allowMissing to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AddFulfillmentPlacesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

setPlaceIds(int index, String value)

public AddFulfillmentPlacesRequest.Builder setPlaceIds(int index, String value)

Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this 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 after adding, then the update will be rejected.

repeated string place_ids = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.
value String

The placeIds to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setProduct(String value)

public AddFulfillmentPlacesRequest.Builder setProduct(String value)

Required. Full resource name of 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, 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) = { ... }

Parameter
Name Description
value String

The product to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setProductBytes(ByteString value)

public AddFulfillmentPlacesRequest.Builder setProductBytes(ByteString value)

Required. Full resource name of 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, 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) = { ... }

Parameter
Name Description
value ByteString

The bytes for product to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AddFulfillmentPlacesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides

setType(String value)

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.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The type to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setTypeBytes(ByteString value)

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

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
AddFulfillmentPlacesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AddFulfillmentPlacesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AddFulfillmentPlacesRequest.Builder
Overrides