Class FulfillmentInfo.Builder (2.45.0)

public static final class FulfillmentInfo.Builder extends GeneratedMessageV3.Builder<FulfillmentInfo.Builder> implements FulfillmentInfoOrBuilder

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

Protobuf type google.cloud.retail.v2beta.FulfillmentInfo

Static Methods

getDescriptor()

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

Methods

addAllPlaceIds(Iterable<String> values)

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

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Parameter
Name Description
values Iterable<String>

The placeIds to add.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

addPlaceIds(String value)

public FulfillmentInfo.Builder addPlaceIds(String value)

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Parameter
Name Description
value String

The placeIds to add.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

addPlaceIdsBytes(ByteString value)

public FulfillmentInfo.Builder addPlaceIdsBytes(ByteString value)

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Parameter
Name Description
value ByteString

The bytes of the placeIds to add.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FulfillmentInfo build()
Returns
Type Description
FulfillmentInfo

buildPartial()

public FulfillmentInfo buildPartial()
Returns
Type Description
FulfillmentInfo

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPlaceIds()

public FulfillmentInfo.Builder clearPlaceIds()

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

clearType()

public FulfillmentInfo.Builder clearType()

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

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.

string type = 1;

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public FulfillmentInfo getDefaultInstanceForType()
Returns
Type Description
FulfillmentInfo

getDescriptorForType()

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

getPlaceIds(int index)

public String getPlaceIds(int index)

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

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)

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

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()

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Returns
Type Description
int

The count of placeIds.

getPlaceIdsList()

public ProtocolStringList getPlaceIdsList()

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Returns
Type Description
ProtocolStringList

A list containing the placeIds.

getType()

public String getType()

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

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.

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

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.

string type = 1;

Returns
Type Description
ByteString

The bytes for type.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FulfillmentInfo other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPlaceIds(int index, String value)

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

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 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 = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The placeIds to set.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

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

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

setType(String value)

public FulfillmentInfo.Builder setType(String value)

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

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.

string type = 1;

Parameter
Name Description
value String

The type to set.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public FulfillmentInfo.Builder setTypeBytes(ByteString value)

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

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.

string type = 1;

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
FulfillmentInfo.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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