Class protos.google.shopping.merchant.lfp.v1beta.LfpMerchantState.LfpStoreState (0.10.0)

Represents a LfpStoreState.

Package

@google-shopping/lfp

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.merchant.lfp.v1beta.LfpMerchantState.ILfpStoreState);

Constructs a new LfpStoreState.

Parameter
Name Description
properties ILfpStoreState

Properties to set

Properties

matchingState

public matchingState: (google.shopping.merchant.lfp.v1beta.LfpMerchantState.LfpStoreState.StoreMatchingState|keyof typeof google.shopping.merchant.lfp.v1beta.LfpMerchantState.LfpStoreState.StoreMatchingState);

LfpStoreState matchingState.

matchingStateHint

public matchingStateHint: string;

LfpStoreState matchingStateHint.

storeCode

public storeCode: string;

LfpStoreState storeCode.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.lfp.v1beta.LfpMerchantState.ILfpStoreState): google.shopping.merchant.lfp.v1beta.LfpMerchantState.LfpStoreState;

Creates a new LfpStoreState instance using the specified properties.

Parameter
Name Description
properties ILfpStoreState

Properties to set

Returns
Type Description
LfpStoreState

LfpStoreState instance

decode(reader, length)

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

Decodes a LfpStoreState 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
LfpStoreState

LfpStoreState

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.lfp.v1beta.LfpMerchantState.LfpStoreState;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
LfpStoreState

LfpStoreState

encode(message, writer)

public static encode(message: google.shopping.merchant.lfp.v1beta.LfpMerchantState.ILfpStoreState, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LfpStoreState message. Does not implicitly messages.

Parameters
Name Description
message ILfpStoreState

LfpStoreState 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.lfp.v1beta.LfpMerchantState.ILfpStoreState, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ILfpStoreState

LfpStoreState 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.lfp.v1beta.LfpMerchantState.LfpStoreState;

Creates a LfpStoreState 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
LfpStoreState

LfpStoreState

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LfpStoreState

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 LfpStoreState to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message LfpStoreState

LfpStoreState

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 LfpStoreState 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