- 2.55.0 (latest)
- 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 static final class LocalInventory.Builder extends GeneratedMessageV3.Builder<LocalInventory.Builder> implements LocalInventoryOrBuilder
The inventory information at a place (e.g. a store) identified by a place ID.
Protobuf type google.cloud.retail.v2.LocalInventory
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LocalInventory.BuilderImplements
LocalInventoryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllFulfillmentTypes(Iterable<String> values)
public LocalInventory.Builder addAllFulfillmentTypes(Iterable<String> values)
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 |
values | Iterable<String> The fulfillmentTypes to add. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
addFulfillmentTypes(String value)
public LocalInventory.Builder addFulfillmentTypes(String value)
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 |
value | String The fulfillmentTypes to add. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
addFulfillmentTypesBytes(ByteString value)
public LocalInventory.Builder addFulfillmentTypesBytes(ByteString value)
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 |
value | ByteString The bytes of the fulfillmentTypes to add. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LocalInventory.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
LocalInventory.Builder |
build()
public LocalInventory build()
Type | Description |
LocalInventory |
buildPartial()
public LocalInventory buildPartial()
Type | Description |
LocalInventory |
clear()
public LocalInventory.Builder clear()
Type | Description |
LocalInventory.Builder |
clearAttributes()
public LocalInventory.Builder clearAttributes()
Type | Description |
LocalInventory.Builder |
clearField(Descriptors.FieldDescriptor field)
public LocalInventory.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
LocalInventory.Builder |
clearFulfillmentTypes()
public LocalInventory.Builder clearFulfillmentTypes()
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 |
LocalInventory.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public LocalInventory.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
LocalInventory.Builder |
clearPlaceId()
public LocalInventory.Builder clearPlaceId()
The place ID for the current set of inventory information.
string place_id = 1;
Type | Description |
LocalInventory.Builder | This builder for chaining. |
clearPriceInfo()
public LocalInventory.Builder clearPriceInfo()
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Type | Description |
LocalInventory.Builder |
clone()
public LocalInventory.Builder clone()
Type | Description |
LocalInventory.Builder |
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.v2.CustomAttribute> attributes = 3;
Name | Description |
key | String |
Type | Description |
boolean |
getAttributes()
public Map<String,CustomAttribute> getAttributes()
Use #getAttributesMap() instead.
Type | Description |
Map<String,CustomAttribute> |
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.v2.CustomAttribute> attributes = 3;
Type | Description |
int |
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.v2.CustomAttribute> attributes = 3;
Type | Description |
Map<String,CustomAttribute> |
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.v2.CustomAttribute> attributes = 3;
Name | Description |
key | String |
defaultValue | CustomAttribute |
Type | Description |
CustomAttribute |
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.v2.CustomAttribute> attributes = 3;
Name | Description |
key | String |
Type | Description |
CustomAttribute |
getDefaultInstanceForType()
public LocalInventory getDefaultInstanceForType()
Type | Description |
LocalInventory |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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. |
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. |
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];
Type | Description |
ProtocolStringList | A list containing the fulfillmentTypes. |
getMutableAttributes()
public Map<String,CustomAttribute> getMutableAttributes()
Use alternate mutation accessors instead.
Type | Description |
Map<String,CustomAttribute> |
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;
Type | Description |
ByteString | The bytes for placeId. |
getPriceInfo()
public PriceInfo getPriceInfo()
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Type | Description |
PriceInfo | The priceInfo. |
getPriceInfoBuilder()
public PriceInfo.Builder getPriceInfoBuilder()
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Type | Description |
PriceInfo.Builder |
getPriceInfoOrBuilder()
public PriceInfoOrBuilder getPriceInfoOrBuilder()
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Type | Description |
PriceInfoOrBuilder |
hasPriceInfo()
public boolean hasPriceInfo()
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Type | Description |
boolean | Whether the priceInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(LocalInventory other)
public LocalInventory.Builder mergeFrom(LocalInventory other)
Name | Description |
other | LocalInventory |
Type | Description |
LocalInventory.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LocalInventory.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
LocalInventory.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public LocalInventory.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
LocalInventory.Builder |
mergePriceInfo(PriceInfo value)
public LocalInventory.Builder mergePriceInfo(PriceInfo value)
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Name | Description |
value | PriceInfo |
Type | Description |
LocalInventory.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LocalInventory.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
LocalInventory.Builder |
putAllAttributes(Map<String,CustomAttribute> values)
public LocalInventory.Builder putAllAttributes(Map<String,CustomAttribute> values)
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.v2.CustomAttribute> attributes = 3;
Name | Description |
values | Map<String,CustomAttribute> |
Type | Description |
LocalInventory.Builder |
putAttributes(String key, CustomAttribute value)
public LocalInventory.Builder putAttributes(String key, CustomAttribute value)
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.v2.CustomAttribute> attributes = 3;
Name | Description |
key | String |
value | CustomAttribute |
Type | Description |
LocalInventory.Builder |
removeAttributes(String key)
public LocalInventory.Builder removeAttributes(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.v2.CustomAttribute> attributes = 3;
Name | Description |
key | String |
Type | Description |
LocalInventory.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public LocalInventory.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
LocalInventory.Builder |
setFulfillmentTypes(int index, String value)
public LocalInventory.Builder setFulfillmentTypes(int index, String value)
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 to set the value at. |
value | String The fulfillmentTypes to set. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
setPlaceId(String value)
public LocalInventory.Builder setPlaceId(String value)
The place ID for the current set of inventory information.
string place_id = 1;
Name | Description |
value | String The placeId to set. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
setPlaceIdBytes(ByteString value)
public LocalInventory.Builder setPlaceIdBytes(ByteString value)
The place ID for the current set of inventory information.
string place_id = 1;
Name | Description |
value | ByteString The bytes for placeId to set. |
Type | Description |
LocalInventory.Builder | This builder for chaining. |
setPriceInfo(PriceInfo value)
public LocalInventory.Builder setPriceInfo(PriceInfo value)
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Name | Description |
value | PriceInfo |
Type | Description |
LocalInventory.Builder |
setPriceInfo(PriceInfo.Builder builderForValue)
public LocalInventory.Builder setPriceInfo(PriceInfo.Builder builderForValue)
Product price and cost information. Google Merchant Center property price.
.google.cloud.retail.v2.PriceInfo price_info = 2;
Name | Description |
builderForValue | PriceInfo.Builder |
Type | Description |
LocalInventory.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LocalInventory.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
LocalInventory.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final LocalInventory.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
LocalInventory.Builder |