com.google.cloud.retail.v2beta

Interface AddFulfillmentPlacesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AddFulfillmentPlacesRequest, AddFulfillmentPlacesRequest.Builder

public interface AddFulfillmentPlacesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
String	getPlaceIds(int index) Required.
com.google.protobuf.ByteString	getPlaceIdsBytes(int index) Required.
int	getPlaceIdsCount() Required.
List<String>	getPlaceIdsList() Required.
String	getProduct() Required.
com.google.protobuf.ByteString	getProductBytes() Required.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getProduct

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) = { ... }

Returns:

The product.

getProductBytes

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) = { ... }

Returns:

The bytes for product.

getType

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

Returns:

The type.

getTypeBytes

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

Returns:

The bytes for type.

getPlaceIdsList

List<String> 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];

Returns:

A list containing the placeIds.

getPlaceIdsCount

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

Returns:

The count of placeIds.

getPlaceIds

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

Parameters:

index - The index of the element to return.

Returns:

The placeIds at the given index.

getPlaceIdsBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the placeIds at the given index.

hasAddTime

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:

Whether the addTime field is set.

getAddTime

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;

Returns:

The addTime.

getAddTimeOrBuilder

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;

getAllowMissing

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;

Returns:

The allowMissing.