Class protos.google.shopping.merchant.inventories.v1beta.RegionalInventory (0.5.0)

Represents a RegionalInventory.

Package

@google-shopping/inventories

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.merchant.inventories.v1beta.IRegionalInventory);

Constructs a new RegionalInventory.

Parameter
Name Description
properties IRegionalInventory

Properties to set

Properties

_availability

public _availability?: "availability";

RegionalInventory _availability.

account

public account: (number|Long|string);

RegionalInventory account.

availability

public availability?: (string|null);

RegionalInventory availability.

customAttributes

public customAttributes: google.shopping.type.ICustomAttribute[];

RegionalInventory customAttributes.

name

public name: string;

RegionalInventory name.

price

public price?: (google.shopping.type.IPrice|null);

RegionalInventory price.

region

public region: string;

RegionalInventory region.

salePrice

public salePrice?: (google.shopping.type.IPrice|null);

RegionalInventory salePrice.

salePriceEffectiveDate

public salePriceEffectiveDate?: (google.type.IInterval|null);

RegionalInventory salePriceEffectiveDate.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.inventories.v1beta.IRegionalInventory): google.shopping.merchant.inventories.v1beta.RegionalInventory;

Creates a new RegionalInventory instance using the specified properties.

Parameter
Name Description
properties IRegionalInventory

Properties to set

Returns
Type Description
RegionalInventory

RegionalInventory instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.inventories.v1beta.RegionalInventory;

Decodes a RegionalInventory message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
RegionalInventory

RegionalInventory

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.inventories.v1beta.RegionalInventory;

Decodes a RegionalInventory message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RegionalInventory

RegionalInventory

encode(message, writer)

public static encode(message: google.shopping.merchant.inventories.v1beta.IRegionalInventory, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RegionalInventory message. Does not implicitly messages.

Parameters
Name Description
message IRegionalInventory

RegionalInventory message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.shopping.merchant.inventories.v1beta.IRegionalInventory, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RegionalInventory message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IRegionalInventory

RegionalInventory message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.shopping.merchant.inventories.v1beta.RegionalInventory;

Creates a RegionalInventory message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
RegionalInventory

RegionalInventory

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RegionalInventory

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this RegionalInventory to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.shopping.merchant.inventories.v1beta.RegionalInventory, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a RegionalInventory message. Also converts values to other types if specified.

Parameters
Name Description
message RegionalInventory

RegionalInventory

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RegionalInventory message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not