Class protos.google.cloud.retail.v2alpha.Product (1.1.6)

Version 1.1.6

• 3.1.0 (latest)
• 2.4.1
• 2.3.1
• 2.1.1
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.6

Represents a Product.

Package

@google-cloud/retail!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2alpha.IProduct);

Constructs a new Product.

Parameter

Name	Description
properties	IProduct Properties to set

Properties

attributes

public attributes: { [k: string]: google.cloud.retail.v2alpha.ICustomAttribute };

Product attributes.

Property Value

Type	Description
{ [k: string]: google.cloud.retail.v2alpha.ICustomAttribute }

availability

public availability: (google.cloud.retail.v2alpha.Product.Availability|keyof typeof google.cloud.retail.v2alpha.Product.Availability);

Product availability.

Property Value

Type	Description
(google.cloud.retail.v2alpha.Product.Availability|keyof typeof google.cloud.retail.v2alpha.Product.Availability)

availableQuantity

public availableQuantity?: (google.protobuf.IInt32Value|null);

Product availableQuantity.

Property Value

Type	Description
(google.protobuf.IInt32Value|null)

availableTime

public availableTime?: (google.protobuf.ITimestamp|null);

Product availableTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

categories

public categories: string[];

Product categories.

Property Value

Type	Description
string[]

description

public description: string;

Product description.

Property Value

Type	Description
string

id

public id: string;

Product id.

Property Value

Type	Description
string

images

public images: google.cloud.retail.v2alpha.IImage[];

Product images.

Property Value

Type	Description
google.cloud.retail.v2alpha.IImage[]

name

public name: string;

Product name.

Property Value

Type	Description
string

priceInfo

public priceInfo?: (google.cloud.retail.v2alpha.IPriceInfo|null);

Product priceInfo.

Property Value

Type	Description
(google.cloud.retail.v2alpha.IPriceInfo|null)

primaryProductId

public primaryProductId: string;

Product primaryProductId.

Property Value

Type	Description
string

tags

public tags: string[];

Product tags.

Property Value

Type	Description
string[]

title

public title: string;

Product title.

Property Value

Type	Description
string

type

public type: (google.cloud.retail.v2alpha.Product.Type|keyof typeof google.cloud.retail.v2alpha.Product.Type);

Product type.

Property Value

Type	Description
(google.cloud.retail.v2alpha.Product.Type|keyof typeof google.cloud.retail.v2alpha.Product.Type)

uri

public uri: string;

Product uri.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.IProduct): google.cloud.retail.v2alpha.Product;

Creates a new Product instance using the specified properties.

Parameter

Name	Description
properties	IProduct Properties to set

Returns

Type	Description
google.cloud.retail.v2alpha.Product	Product instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.Product;

Decodes a Product message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.retail.v2alpha.Product	Product

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.Product;

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.retail.v2alpha.Product	Product

encode(message, writer)

public static encode(message: google.cloud.retail.v2alpha.IProduct, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Product message. Does not implicitly messages.

Parameters

Name	Description
message	IProduct Product 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.cloud.retail.v2alpha.IProduct, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IProduct Product 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.cloud.retail.v2alpha.Product;

Creates a Product 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
google.cloud.retail.v2alpha.Product	Product

toJSON()

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

Converts this Product to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.retail.v2alpha.Product, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	google.cloud.retail.v2alpha.Product Product
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 Product 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