com.google.cloud.retail.v2beta

Class AddFulfillmentPlacesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2beta.AddFulfillmentPlacesRequest

All Implemented Interfaces:

AddFulfillmentPlacesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AddFulfillmentPlacesRequest
extends com.google.protobuf.GeneratedMessageV3
implements AddFulfillmentPlacesRequestOrBuilder

 Request message for
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces]
 method.
 

Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddFulfillmentPlacesRequest.Builder Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_TIME_FIELD_NUMBER
static int	ALLOW_MISSING_FIELD_NUMBER
static int	PLACE_IDS_FIELD_NUMBER
static int	PRODUCT_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getAddTime() The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information.
com.google.protobuf.TimestampOrBuilder	getAddTimeOrBuilder() The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information.
boolean	getAllowMissing() If set to true, and the [Product][google.cloud.retail.v2beta.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.v2beta.Product] is created.
static AddFulfillmentPlacesRequest	getDefaultInstance()
AddFulfillmentPlacesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<AddFulfillmentPlacesRequest>	getParserForType()
String	getPlaceIds(int index) Required.
com.google.protobuf.ByteString	getPlaceIdsBytes(int index) Required.
int	getPlaceIdsCount() Required.
com.google.protobuf.ProtocolStringList	getPlaceIdsList() Required.
String	getProduct() Required.
com.google.protobuf.ByteString	getProductBytes() Required.
int	getSerializedSize()
String	getType() Required.
com.google.protobuf.ByteString	getTypeBytes() Required.
boolean	hasAddTime() The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AddFulfillmentPlacesRequest.Builder	newBuilder()
static AddFulfillmentPlacesRequest.Builder	newBuilder(AddFulfillmentPlacesRequest prototype)
AddFulfillmentPlacesRequest.Builder	newBuilderForType()
protected AddFulfillmentPlacesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AddFulfillmentPlacesRequest	parseDelimitedFrom(InputStream input)
static AddFulfillmentPlacesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddFulfillmentPlacesRequest	parseFrom(byte[] data)
static AddFulfillmentPlacesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddFulfillmentPlacesRequest	parseFrom(ByteBuffer data)
static AddFulfillmentPlacesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddFulfillmentPlacesRequest	parseFrom(com.google.protobuf.ByteString data)
static AddFulfillmentPlacesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddFulfillmentPlacesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AddFulfillmentPlacesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddFulfillmentPlacesRequest	parseFrom(InputStream input)
static AddFulfillmentPlacesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AddFulfillmentPlacesRequest>	parser()
AddFulfillmentPlacesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PLACE_IDS_FIELD_NUMBER

public static final int PLACE_IDS_FIELD_NUMBER

See Also:

Constant Field Values

ADD_TIME_FIELD_NUMBER

public static final int ADD_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProduct

public String getProduct()

 Required. Full resource name of
 [Product][google.cloud.retail.v2beta.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.v2beta.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 AddFulfillmentPlacesRequestOrBuilder

Returns:

The product.

getProductBytes

public com.google.protobuf.ByteString getProductBytes()

 Required. Full resource name of
 [Product][google.cloud.retail.v2beta.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.v2beta.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 AddFulfillmentPlacesRequestOrBuilder

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.v2beta.FulfillmentInfo.type].
 

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

Specified by:

getType in interface AddFulfillmentPlacesRequestOrBuilder

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.v2beta.FulfillmentInfo.type].
 

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

Specified by:

getTypeBytes in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

The bytes for type.

getPlaceIdsList

public com.google.protobuf.ProtocolStringList getPlaceIdsList()

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

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

Specified by:

getPlaceIdsList in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

A list containing the placeIds.

getPlaceIdsCount

public int getPlaceIdsCount()

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

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

Specified by:

getPlaceIdsCount in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

The count of placeIds.

getPlaceIds

public String getPlaceIds(int index)

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

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

Specified by:

getPlaceIds in interface AddFulfillmentPlacesRequestOrBuilder

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.v2beta.AddFulfillmentPlacesRequest.type], such
 as the store IDs for "pickup-in-store" or the region IDs for
 "same-day-delivery" to be added for this
 [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.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][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type] after
 adding, then the update will be rejected.
 

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

Specified by:

getPlaceIdsBytes in interface AddFulfillmentPlacesRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the placeIds at the given index.

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;

Specified by:

hasAddTime in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

Whether the addTime field is set.

getAddTime

public com.google.protobuf.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;

Specified by:

getAddTime in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

The addTime.

getAddTimeOrBuilder

public com.google.protobuf.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;

Specified by:

getAddTimeOrBuilder in interface AddFulfillmentPlacesRequestOrBuilder

getAllowMissing

public boolean getAllowMissing()

 If set to true, and the [Product][google.cloud.retail.v2beta.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.v2beta.Product] is created. If set to false,
 a NOT_FOUND error is returned if the
 [Product][google.cloud.retail.v2beta.Product] is not found.
 

bool allow_missing = 5;

Specified by:

getAllowMissing in interface AddFulfillmentPlacesRequestOrBuilder

Returns:

The allowMissing.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 AddFulfillmentPlacesRequest parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddFulfillmentPlacesRequest parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddFulfillmentPlacesRequest parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddFulfillmentPlacesRequest parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static AddFulfillmentPlacesRequest parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static AddFulfillmentPlacesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public AddFulfillmentPlacesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AddFulfillmentPlacesRequest.Builder newBuilder()

newBuilder

public static AddFulfillmentPlacesRequest.Builder newBuilder(AddFulfillmentPlacesRequest prototype)

toBuilder

public AddFulfillmentPlacesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AddFulfillmentPlacesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AddFulfillmentPlacesRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<AddFulfillmentPlacesRequest> 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.GeneratedMessageV3

getDefaultInstanceForType

public AddFulfillmentPlacesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder