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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACCOUNT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int AVAILABILITY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int CUSTOM_ATTRIBUTES_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int INSTORE_PRODUCT_LOCATION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PICKUP_METHOD_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PICKUP_SLA_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PRICE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int QUANTITY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int SALE_PRICE_EFFECTIVE_DATE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int SALE_PRICE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int STORE_CODE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static LocalInventory getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static LocalInventory.Builder newBuilder()
public static LocalInventory.Builder newBuilder(LocalInventory prototype)
public static LocalInventory parseDelimitedFrom(InputStream input)
public static LocalInventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static LocalInventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteString data)
public static LocalInventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(CodedInputStream input)
public static LocalInventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(InputStream input)
public static LocalInventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteBuffer data)
public static LocalInventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<LocalInventory> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
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.
|
public String getAvailability()
Returns |
Type |
Description |
String |
The availability.
|
public ByteString getAvailabilityBytes()
Returns |
Type |
Description |
ByteString |
The bytes for availability.
|
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 |
|
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 |
|
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> |
|
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 |
|
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> |
|
public LocalInventory getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
public Parser<LocalInventory> getParserForType()
Overrides
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.
|
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.
|
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.
|
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.
|
Price of the product at this store.
.google.shopping.type.Price price = 4;
Returns |
Type |
Description |
com.google.shopping.type.Price |
The price.
|
public PriceOrBuilder getPriceOrBuilder()
Price of the product at this store.
.google.shopping.type.Price price = 4;
Returns |
Type |
Description |
com.google.shopping.type.PriceOrBuilder |
|
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.
|
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.
|
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.
|
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 |
|
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 |
|
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
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.
|
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.
|
public boolean hasAvailability()
Returns |
Type |
Description |
boolean |
Whether the availability field is set.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public LocalInventory.Builder newBuilderForType()
protected LocalInventory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public LocalInventory.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides