public final class LocalInventory extends GeneratedMessageV3 implements LocalInventoryOrBuilder
The inventory information at a place (e.g. a store) identified
by a place ID.
Protobuf type google.cloud.retail.v2alpha.LocalInventory
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
FULFILLMENT_TYPES_FIELD_NUMBER
public static final int FULFILLMENT_TYPES_FIELD_NUMBER
Field Value
PLACE_ID_FIELD_NUMBER
public static final int PLACE_ID_FIELD_NUMBER
Field Value
PRICE_INFO_FIELD_NUMBER
public static final int PRICE_INFO_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static LocalInventory getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static LocalInventory.Builder newBuilder()
Returns
newBuilder(LocalInventory prototype)
public static LocalInventory.Builder newBuilder(LocalInventory prototype)
Parameter
Returns
public static LocalInventory parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static LocalInventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static LocalInventory parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static LocalInventory parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LocalInventory parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static LocalInventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LocalInventory parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static LocalInventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static LocalInventory parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<LocalInventory> parser()
Returns
Methods
containsAttributes(String key)
public 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.v2alpha.CustomAttribute> attributes = 3;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAttributes()
public Map<String,CustomAttribute> getAttributes()
Returns
getAttributesCount()
public 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.v2alpha.CustomAttribute> attributes = 3;
getAttributesMap()
public 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.v2alpha.CustomAttribute> attributes = 3;
getAttributesOrDefault(String key, CustomAttribute defaultValue)
public 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.v2alpha.CustomAttribute> attributes = 3;
getAttributesOrThrow(String key)
public 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.v2alpha.CustomAttribute> attributes = 3;
getDefaultInstanceForType()
public LocalInventory getDefaultInstanceForType()
Returns
getFulfillmentTypes(int index)
public 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];
| 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 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];
| 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 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];
| Type | Description |
| int | The count of fulfillmentTypes.
|
getFulfillmentTypesList()
public ProtocolStringList 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];
getParserForType()
public Parser<LocalInventory> getParserForType()
Returns
Overrides
getPlaceId()
public String getPlaceId()
The place ID for the current set of inventory information.
string place_id = 1;
| Type | Description |
| String | The placeId.
|
getPlaceIdBytes()
public ByteString getPlaceIdBytes()
The place ID for the current set of inventory information.
string place_id = 1;
getPriceInfo()
public PriceInfo getPriceInfo()
Product price and cost information.
Google Merchant Center property
price.
.google.cloud.retail.v2alpha.PriceInfo price_info = 2;
getPriceInfoOrBuilder()
public PriceInfoOrBuilder getPriceInfoOrBuilder()
Product price and cost information.
Google Merchant Center property
price.
.google.cloud.retail.v2alpha.PriceInfo price_info = 2;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasPriceInfo()
public boolean hasPriceInfo()
Product price and cost information.
Google Merchant Center property
price.
.google.cloud.retail.v2alpha.PriceInfo price_info = 2;
| Type | Description |
| boolean | Whether the priceInfo field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public LocalInventory.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LocalInventory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public LocalInventory.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
