Class LfpInventory (0.13.0)

public final class LfpInventory extends GeneratedMessageV3 implements LfpInventoryOrBuilder

Local Inventory for the merchant.

Protobuf type google.shopping.merchant.lfp.v1beta.LfpInventory

Static Fields

AVAILABILITY_FIELD_NUMBER

public static final int AVAILABILITY_FIELD_NUMBER
Field Value
Type Description
int

COLLECTION_TIME_FIELD_NUMBER

public static final int COLLECTION_TIME_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_LANGUAGE_FIELD_NUMBER

public static final int CONTENT_LANGUAGE_FIELD_NUMBER
Field Value
Type Description
int

FEED_LABEL_FIELD_NUMBER

public static final int FEED_LABEL_FIELD_NUMBER
Field Value
Type Description
int

GTIN_FIELD_NUMBER

public static final int GTIN_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OFFER_ID_FIELD_NUMBER

public static final int OFFER_ID_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

REGION_CODE_FIELD_NUMBER

public static final int REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

STORE_CODE_FIELD_NUMBER

public static final int STORE_CODE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_ACCOUNT_FIELD_NUMBER

public static final int TARGET_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LfpInventory getDefaultInstance()
Returns
Type Description
LfpInventory

getDescriptor()

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

newBuilder()

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

newBuilder(LfpInventory prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAvailability()

public String getAvailability()

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

string availability = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The availability.

getAvailabilityBytes()

public ByteString getAvailabilityBytes()

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

string availability = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for availability.

getCollectionTime()

public Timestamp getCollectionTime()

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

.google.protobuf.Timestamp collection_time = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The collectionTime.

getCollectionTimeOrBuilder()

public TimestampOrBuilder getCollectionTimeOrBuilder()

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

.google.protobuf.Timestamp collection_time = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getContentLanguage()

public String getContentLanguage()

Required. The two-letter ISO 639-1 language code for the item.

string content_language = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The contentLanguage.

getContentLanguageBytes()

public ByteString getContentLanguageBytes()

Required. The two-letter ISO 639-1 language code for the item.

string content_language = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for contentLanguage.

getDefaultInstanceForType()

public LfpInventory getDefaultInstanceForType()
Returns
Type Description
LfpInventory

getFeedLabel()

public String getFeedLabel()

Optional. The feed label for the product. If this is not set, it will default to regionCode.

optional string feed_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The feedLabel.

getFeedLabelBytes()

public ByteString getFeedLabelBytes()

Optional. The feed label for the product. If this is not set, it will default to regionCode.

optional string feed_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for feedLabel.

getGtin()

public String getGtin()

Optional. The Global Trade Item Number of the product.

optional string gtin = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gtin.

getGtinBytes()

public ByteString getGtinBytes()

Optional. The Global Trade Item Number of the product.

optional string gtin = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gtin.

getName()

public String getName()

Output only. Identifier. The name for the LfpInventory resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The name for the LfpInventory resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

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

Returns
Type Description
ByteString

The bytes for name.

getOfferId()

public String getOfferId()

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

Note: if the merchant sells the same product new and used, they should have different IDs.

string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The offerId.

getOfferIdBytes()

public ByteString getOfferIdBytes()

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

Note: if the merchant sells the same product new and used, they should have different IDs.

string offer_id = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for offerId.

getParserForType()

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

getPickupMethod()

public String getPickupMethod()

Optional. Supported pickup method for this offer. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pickupMethod.

getPickupMethodBytes()

public ByteString getPickupMethodBytes()

Optional. Supported pickup method for this offer. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pickupMethod.

getPickupSla()

public String getPickupSla()

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

optional string pickup_sla = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pickupSla.

getPickupSlaBytes()

public ByteString getPickupSlaBytes()

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

optional string pickup_sla = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pickupSla.

getPrice()

public Price getPrice()

Optional. The current price of the product.

.google.shopping.type.Price price = 8 [(.google.api.field_behavior) = OPTIONAL];

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

The price.

getPriceOrBuilder()

public PriceOrBuilder getPriceOrBuilder()

Optional. The current price of the product.

.google.shopping.type.Price price = 8 [(.google.api.field_behavior) = OPTIONAL];

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

getQuantity()

public long getQuantity()

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

optional int64 quantity = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The quantity.

getRegionCode()

public String getRegionCode()

Required. The CLDR territory code for the country where the product is sold.

string region_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public ByteString getRegionCodeBytes()

Required. The CLDR territory code for the country where the product is sold.

string region_code = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for regionCode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStoreCode()

public String getStoreCode()

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.

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

Returns
Type Description
String

The storeCode.

getStoreCodeBytes()

public ByteString getStoreCodeBytes()

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.

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

Returns
Type Description
ByteString

The bytes for storeCode.

getTargetAccount()

public long getTargetAccount()

Required. The Merchant Center ID of the merchant to submit the inventory for.

int64 target_account = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The targetAccount.

hasCollectionTime()

public boolean hasCollectionTime()

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

.google.protobuf.Timestamp collection_time = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the collectionTime field is set.

hasFeedLabel()

public boolean hasFeedLabel()

Optional. The feed label for the product. If this is not set, it will default to regionCode.

optional string feed_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the feedLabel field is set.

hasGtin()

public boolean hasGtin()

Optional. The Global Trade Item Number of the product.

optional string gtin = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gtin field is set.

hasPickupMethod()

public boolean hasPickupMethod()

Optional. Supported pickup method for this offer. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pickupMethod field is set.

hasPickupSla()

public boolean hasPickupSla()

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

optional string pickup_sla = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pickupSla field is set.

hasPrice()

public boolean hasPrice()

Optional. The current price of the product.

.google.shopping.type.Price price = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the price field is set.

hasQuantity()

public boolean hasQuantity()

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

optional int64 quantity = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the quantity 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 LfpInventory.Builder newBuilderForType()
Returns
Type Description
LfpInventory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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