Class RegionalInventory (0.23.0)

public final class RegionalInventory extends GeneratedMessageV3 implements RegionalInventoryOrBuilder

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific region. For a list of all accepted attribute values, see the regional product inventory data specification.

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

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

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRICE_FIELD_NUMBER

public static final int PRICE_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

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

Static Methods

getDefaultInstance()

public static RegionalInventory getDefaultInstance()
Returns
Type Description
RegionalInventory

getDescriptor()

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

newBuilder()

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

newBuilder(RegionalInventory prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 in this region. For accepted attribute values, see the regional product inventory data specification

optional string availability = 7;

Returns
Type Description
String

The availability.

getAvailabilityBytes()

public ByteString getAvailabilityBytes()

Availability of the product in this region. For accepted attribute values, see the regional 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 = 8;

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 = 8;

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 = 8;

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 = 8;

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 = 8;

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

getDefaultInstanceForType()

public RegionalInventory getDefaultInstanceForType()
Returns
Type Description
RegionalInventory

getName()

public String getName()

Output only. The name of the RegionalInventory resource. Format: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}

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 RegionalInventory resource. Format: {regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPrice()

public Price getPrice()

Price of the product in this region.

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

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

The price.

getPriceOrBuilder()

public PriceOrBuilder getPriceOrBuilder()

Price of the product in this region.

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

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

getRegion()

public String getRegion()

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Returns
Type Description
ByteString

The bytes for region.

getSalePrice()

public Price getSalePrice()

Sale price of the product in this region. 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 price in this region.

.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 price in this region.

.google.type.Interval sale_price_effective_date = 6;

Returns
Type Description
com.google.type.IntervalOrBuilder

getSalePriceOrBuilder()

public PriceOrBuilder getSalePriceOrBuilder()

Sale price of the product in this region. 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

hasAvailability()

public boolean hasAvailability()

Availability of the product in this region. For accepted attribute values, see the regional product inventory data specification

optional string availability = 7;

Returns
Type Description
boolean

Whether the availability field is set.

hasPrice()

public boolean hasPrice()

Price of the product in this region.

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

Returns
Type Description
boolean

Whether the price field is set.

hasSalePrice()

public boolean hasSalePrice()

Sale price of the product in this region. 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 price in this region.

.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 RegionalInventory.Builder newBuilderForType()
Returns
Type Description
RegionalInventory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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