Class FulfillmentInfo (2.54.0)

public final class FulfillmentInfo extends GeneratedMessageV3 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.v2.FulfillmentInfo

Static Fields

PLACE_IDS_FIELD_NUMBER

public static final int PLACE_IDS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FulfillmentInfo getDefaultInstance()
Returns
Type Description
FulfillmentInfo

getDescriptor()

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

newBuilder()

public static FulfillmentInfo.Builder newBuilder()
Returns
Type Description
FulfillmentInfo.Builder

newBuilder(FulfillmentInfo prototype)

public static FulfillmentInfo.Builder newBuilder(FulfillmentInfo prototype)
Parameter
Name Description
prototype FulfillmentInfo
Returns
Type Description
FulfillmentInfo.Builder

parseDelimitedFrom(InputStream input)

public static FulfillmentInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FulfillmentInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FulfillmentInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FulfillmentInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FulfillmentInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FulfillmentInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FulfillmentInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FulfillmentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FulfillmentInfo> parser()
Returns
Type Description
Parser<FulfillmentInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FulfillmentInfo getDefaultInstanceForType()
Returns
Type Description
FulfillmentInfo

getParserForType()

public Parser<FulfillmentInfo> getParserForType()
Returns
Type Description
Parser<FulfillmentInfo>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FulfillmentInfo.Builder newBuilderForType()
Returns
Type Description
FulfillmentInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FulfillmentInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FulfillmentInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FulfillmentInfo.Builder toBuilder()
Returns
Type Description
FulfillmentInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException