Interface LocalInventoryOrBuilder (2.38.0)

Version 2.38.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public interface LocalInventoryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

Additional local inventory attributes, for example, store name, promotion tags, etc.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• At most 30 attributes are allowed.
• The key must be a UTF-8 encoded string with a length limit of 32 characters.
• The key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.
• The attribute values must be of the same type (text or number).
• Only 1 value is allowed for each attribute.
• For text values, the length limit is 256 UTF-8 characters.
• The attribute does not support search. The searchable field should be unset or set to false.
• The max summed total bytes of custom attribute keys and values per product is 5MiB.

map<string, .google.cloud.retail.v2beta.CustomAttribute> attributes = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes() (deprecated)

public abstract Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesCount()

public abstract int getAttributesCount()

Additional local inventory attributes, for example, store name, promotion tags, etc.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• At most 30 attributes are allowed.
• The key must be a UTF-8 encoded string with a length limit of 32 characters.
• The key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.
• The attribute values must be of the same type (text or number).
• Only 1 value is allowed for each attribute.
• For text values, the length limit is 256 UTF-8 characters.
• The attribute does not support search. The searchable field should be unset or set to false.
• The max summed total bytes of custom attribute keys and values per product is 5MiB.

map<string, .google.cloud.retail.v2beta.CustomAttribute> attributes = 3;

Returns
Type	Description
int

getAttributesMap()

public abstract Map<String,CustomAttribute> getAttributesMap()

Additional local inventory attributes, for example, store name, promotion tags, etc.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• At most 30 attributes are allowed.
• The key must be a UTF-8 encoded string with a length limit of 32 characters.
• The key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.
• The attribute values must be of the same type (text or number).
• Only 1 value is allowed for each attribute.
• For text values, the length limit is 256 UTF-8 characters.
• The attribute does not support search. The searchable field should be unset or set to false.
• The max summed total bytes of custom attribute keys and values per product is 5MiB.

map<string, .google.cloud.retail.v2beta.CustomAttribute> attributes = 3;

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesOrDefault(String key, CustomAttribute defaultValue)

public abstract CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)

Additional local inventory attributes, for example, store name, promotion tags, etc.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• At most 30 attributes are allowed.
• The key must be a UTF-8 encoded string with a length limit of 32 characters.
• The key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.
• The attribute values must be of the same type (text or number).
• Only 1 value is allowed for each attribute.
• For text values, the length limit is 256 UTF-8 characters.
• The attribute does not support search. The searchable field should be unset or set to false.
• The max summed total bytes of custom attribute keys and values per product is 5MiB.

map<string, .google.cloud.retail.v2beta.CustomAttribute> attributes = 3;

Parameters
Name	Description
key	String
defaultValue	CustomAttribute

Returns
Type	Description
CustomAttribute

getAttributesOrThrow(String key)

public abstract CustomAttribute getAttributesOrThrow(String key)

Additional local inventory attributes, for example, store name, promotion tags, etc.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• At most 30 attributes are allowed.
• The key must be a UTF-8 encoded string with a length limit of 32 characters.
• The key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or KEY_1_LIKE_THIS.
• The attribute values must be of the same type (text or number).
• Only 1 value is allowed for each attribute.
• For text values, the length limit is 256 UTF-8 characters.
• The attribute does not support search. The searchable field should be unset or set to false.
• The max summed total bytes of custom attribute keys and values per product is 5MiB.

map<string, .google.cloud.retail.v2beta.CustomAttribute> attributes = 3;

Parameter
Name	Description
key	String

Returns
Type	Description
CustomAttribute

getFulfillmentTypes(int index)

public abstract String getFulfillmentTypes(int index)

Input only. Supported fulfillment types. Valid fulfillment type values include 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.

  All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string fulfillment_types = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The fulfillmentTypes at the given index.

getFulfillmentTypesBytes(int index)

public abstract ByteString getFulfillmentTypesBytes(int index)

Input only. Supported fulfillment types. Valid fulfillment type values include 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.

  All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string fulfillment_types = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the fulfillmentTypes at the given index.

getFulfillmentTypesCount()

public abstract int getFulfillmentTypesCount()

Input only. Supported fulfillment types. Valid fulfillment type values include 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.

  All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string fulfillment_types = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The count of fulfillmentTypes.

getFulfillmentTypesList()

public abstract List<String> getFulfillmentTypesList()

Input only. Supported fulfillment types. Valid fulfillment type values include 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.

  All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string fulfillment_types = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
List<String>	A list containing the fulfillmentTypes.

getPlaceId()

public abstract String getPlaceId()

The place ID for the current set of inventory information.

string place_id = 1;

Returns
Type	Description
String	The placeId.

getPlaceIdBytes()

public abstract ByteString getPlaceIdBytes()

The place ID for the current set of inventory information.

string place_id = 1;

Returns
Type	Description
ByteString	The bytes for placeId.

getPriceInfo()

public abstract PriceInfo getPriceInfo()

Product price and cost information.

Google Merchant Center property price.

.google.cloud.retail.v2beta.PriceInfo price_info = 2;

Returns
Type	Description
PriceInfo	The priceInfo.

getPriceInfoOrBuilder()

public abstract PriceInfoOrBuilder getPriceInfoOrBuilder()

Product price and cost information.

Google Merchant Center property price.

.google.cloud.retail.v2beta.PriceInfo price_info = 2;

Returns
Type	Description
PriceInfoOrBuilder

hasPriceInfo()

public abstract boolean hasPriceInfo()

Product price and cost information.

Google Merchant Center property price.

.google.cloud.retail.v2beta.PriceInfo price_info = 2;

Returns
Type	Description
boolean	Whether the priceInfo field is set.