Class protos.google.cloud.retail.v2.CompleteQueryRequest (1.2.2)

Represents a CompleteQueryRequest.

Package

@google-cloud/retail!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2.ICompleteQueryRequest);

Constructs a new CompleteQueryRequest.

Parameter

Name	Description
properties	`ICompleteQueryRequest` Properties to set

Properties

catalog

public catalog: string;

CompleteQueryRequest catalog.

Property Value

Type	Description
string

dataset

public dataset: string;

CompleteQueryRequest dataset.

Property Value

Type	Description
string

deviceType

public deviceType: string;

CompleteQueryRequest deviceType.

Property Value

Type	Description
string

languageCodes

public languageCodes: string[];

CompleteQueryRequest languageCodes.

Property Value

Type	Description
string[]

maxSuggestions

public maxSuggestions: number;

CompleteQueryRequest maxSuggestions.

Property Value

Type	Description
number

query

public query: string;

CompleteQueryRequest query.

Property Value

Type	Description
string

visitorId

public visitorId: string;

CompleteQueryRequest visitorId.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.ICompleteQueryRequest): google.cloud.retail.v2.CompleteQueryRequest;

Creates a new CompleteQueryRequest instance using the specified properties.

Parameter

Name	Description
properties	`ICompleteQueryRequest` Properties to set

Returns

Type	Description
google.cloud.retail.v2.CompleteQueryRequest	CompleteQueryRequest instance

decode(reader, length)

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

Decodes a CompleteQueryRequest 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.v2.CompleteQueryRequest	CompleteQueryRequest

decodeDelimited(reader)

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

Decodes a CompleteQueryRequest 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.v2.CompleteQueryRequest	CompleteQueryRequest

encode(message, writer)

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

Encodes the specified CompleteQueryRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`ICompleteQueryRequest` CompleteQueryRequest 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.v2.ICompleteQueryRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ICompleteQueryRequest` CompleteQueryRequest 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.v2.CompleteQueryRequest;

Creates a CompleteQueryRequest 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.v2.CompleteQueryRequest	CompleteQueryRequest

toJSON()

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

Converts this CompleteQueryRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.retail.v2.CompleteQueryRequest` CompleteQueryRequest
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 CompleteQueryRequest 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