Class LocalInventory (0.25.0)

public final class LocalInventory extends GeneratedMessageV3 implements LocalInventoryOrBuilder

Local inventory information for the product. Represents in-store information for a specific product at the store specified by storeCode. For a list of all accepted attribute values, see the local product inventory data specification.

Protobuf type google.shopping.merchant.inventories.v1beta.LocalInventory

Static Fields

ACCOUNT_FIELD_NUMBER

public static final int ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

AVAILABILITY_FIELD_NUMBER

public static final int AVAILABILITY_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_ATTRIBUTES_FIELD_NUMBER

public static final int CUSTOM_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

INSTORE_PRODUCT_LOCATION_FIELD_NUMBER

public static final int INSTORE_PRODUCT_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PICKUP_METHOD_FIELD_NUMBER

public static final int PICKUP_METHOD_FIELD_NUMBER
Field Value
Type Description
int

PICKUP_SLA_FIELD_NUMBER

public static final int PICKUP_SLA_FIELD_NUMBER
Field Value
Type Description
int

PRICE_FIELD_NUMBER

public static final int PRICE_FIELD_NUMBER
Field Value
Type Description
int

QUANTITY_FIELD_NUMBER

public static final int QUANTITY_FIELD_NUMBER
Field Value
Type Description
int

SALE_PRICE_EFFECTIVE_DATE_FIELD_NUMBER

public static final int SALE_PRICE_EFFECTIVE_DATE_FIELD_NUMBER
Field Value
Type Description
int

SALE_PRICE_FIELD_NUMBER

public static final int SALE_PRICE_FIELD_NUMBER
Field Value
Type Description
int

STORE_CODE_FIELD_NUMBER

public static final int STORE_CODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LocalInventory getDefaultInstance()
Returns
Type Description
LocalInventory

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LocalInventory.Builder newBuilder()
Returns
Type Description
LocalInventory.Builder

newBuilder(LocalInventory prototype)

public static LocalInventory.Builder newBuilder(LocalInventory prototype)
Parameter
Name Description
prototype LocalInventory
Returns
Type Description
LocalInventory.Builder

parseDelimitedFrom(InputStream input)

public static LocalInventory parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LocalInventory parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocalInventory parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocalInventory parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LocalInventory parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LocalInventory parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocalInventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LocalInventory> parser()
Returns
Type Description
Parser<LocalInventory>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccount()

public long getAccount()

Output only. The account that owns the product. This field will be ignored if set by the client.

int64 account = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The account.

getAvailability()

public String getAvailability()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
String

The availability.

getAvailabilityBytes()

public ByteString getAvailabilityBytes()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
ByteString

The bytes for availability.

getCustomAttributes(int index)

public CustomAttribute getCustomAttributes(int index)

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Parameter
Name Description
index int
Returns
Type Description
com.google.shopping.type.CustomAttribute

getCustomAttributesCount()

public int getCustomAttributesCount()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Returns
Type Description
int

getCustomAttributesList()

public List<CustomAttribute> getCustomAttributesList()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Returns
Type Description
List<com.google.shopping.type.CustomAttribute>

getCustomAttributesOrBuilder(int index)

public CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index)

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Parameter
Name Description
index int
Returns
Type Description
com.google.shopping.type.CustomAttributeOrBuilder

getCustomAttributesOrBuilderList()

public List<? extends CustomAttributeOrBuilder> getCustomAttributesOrBuilderList()

A list of custom (merchant-provided) attributes. You can also use CustomAttribute to submit any attribute of the data specification in its generic form.

repeated .google.shopping.type.CustomAttribute custom_attributes = 12;

Returns
Type Description
List<? extends com.google.shopping.type.CustomAttributeOrBuilder>

getDefaultInstanceForType()

public LocalInventory getDefaultInstanceForType()
Returns
Type Description
LocalInventory

getInstoreProductLocation()

public String getInstoreProductLocation()

Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 11;

Returns
Type Description
String

The instoreProductLocation.

getInstoreProductLocationBytes()

public ByteString getInstoreProductLocationBytes()

Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 11;

Returns
Type Description
ByteString

The bytes for instoreProductLocation.

getName()

public String getName()

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the LocalInventory resource. Format: accounts/{account}/products/{product}/localInventories/{store_code}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<LocalInventory> getParserForType()
Returns
Type Description
Parser<LocalInventory>
Overrides

getPickupMethod()

public String getPickupMethod()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
String

The pickupMethod.

getPickupMethodBytes()

public ByteString getPickupMethodBytes()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
ByteString

The bytes for pickupMethod.

getPickupSla()

public String getPickupSla()

Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
String

The pickupSla.

getPickupSlaBytes()

public ByteString getPickupSlaBytes()

Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
ByteString

The bytes for pickupSla.

getPrice()

public Price getPrice()

Price of the product at this store.

.google.shopping.type.Price price = 4;

Returns
Type Description
com.google.shopping.type.Price

The price.

getPriceOrBuilder()

public PriceOrBuilder getPriceOrBuilder()

Price of the product at this store.

.google.shopping.type.Price price = 4;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getQuantity()

public long getQuantity()

Quantity of the product available at this store. Must be greater than or equal to zero.

optional int64 quantity = 8;

Returns
Type Description
long

The quantity.

getSalePrice()

public Price getSalePrice()

Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 5;

Returns
Type Description
com.google.shopping.type.Price

The salePrice.

getSalePriceEffectiveDate()

public Interval getSalePriceEffectiveDate()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
com.google.type.Interval

The salePriceEffectiveDate.

getSalePriceEffectiveDateOrBuilder()

public IntervalOrBuilder getSalePriceEffectiveDateOrBuilder()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
com.google.type.IntervalOrBuilder

getSalePriceOrBuilder()

public PriceOrBuilder getSalePriceOrBuilder()

Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 5;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStoreCode()

public String getStoreCode()

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The storeCode.

getStoreCodeBytes()

public ByteString getStoreCodeBytes()

Required. Immutable. Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information.

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for storeCode.

hasAvailability()

public boolean hasAvailability()

Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

optional string availability = 7;

Returns
Type Description
boolean

Whether the availability field is set.

hasInstoreProductLocation()

public boolean hasInstoreProductLocation()

Location of the product inside the store. Maximum length is 20 bytes.

optional string instore_product_location = 11;

Returns
Type Description
boolean

Whether the instoreProductLocation field is set.

hasPickupMethod()

public boolean hasPickupMethod()

Supported pickup method for this product. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification

optional string pickup_method = 9;

Returns
Type Description
boolean

Whether the pickupMethod field is set.

hasPickupSla()

public boolean hasPickupSla()

Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with pickupMethod. For accepted attribute values, see the local product inventory data specification

optional string pickup_sla = 10;

Returns
Type Description
boolean

Whether the pickupSla field is set.

hasPrice()

public boolean hasPrice()

Price of the product at this store.

.google.shopping.type.Price price = 4;

Returns
Type Description
boolean

Whether the price field is set.

hasQuantity()

public boolean hasQuantity()

Quantity of the product available at this store. Must be greater than or equal to zero.

optional int64 quantity = 8;

Returns
Type Description
boolean

Whether the quantity field is set.

hasSalePrice()

public boolean hasSalePrice()

Sale price of the product at this store. Mandatory if salePriceEffectiveDate is defined.

.google.shopping.type.Price sale_price = 5;

Returns
Type Description
boolean

Whether the salePrice field is set.

hasSalePriceEffectiveDate()

public boolean hasSalePriceEffectiveDate()

The TimePeriod of the sale at this store.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
boolean

Whether the salePriceEffectiveDate field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LocalInventory.Builder newBuilderForType()
Returns
Type Description
LocalInventory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LocalInventory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LocalInventory.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LocalInventory.Builder toBuilder()
Returns
Type Description
LocalInventory.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException