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

Represents a SearchResponse.

Package

@google-cloud/retail!

Constructors

(constructor)(properties)

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

Constructs a new SearchResponse.

Parameter

Name	Description
properties	`ISearchResponse` Properties to set

Properties

attributionToken

public attributionToken: string;

SearchResponse attributionToken.

Property Value

Type	Description
string

correctedQuery

public correctedQuery: string;

SearchResponse correctedQuery.

Property Value

Type	Description
string

facets

public facets: google.cloud.retail.v2.SearchResponse.IFacet[];

SearchResponse facets.

Property Value

Type	Description
google.cloud.retail.v2.SearchResponse.IFacet[]

nextPageToken

public nextPageToken: string;

SearchResponse nextPageToken.

Property Value

Type	Description
string

queryExpansionInfo

public queryExpansionInfo?: (google.cloud.retail.v2.SearchResponse.IQueryExpansionInfo|null);

SearchResponse queryExpansionInfo.

Property Value

Type	Description
(google.cloud.retail.v2.SearchResponse.IQueryExpansionInfo\|null)

redirectUri

public redirectUri: string;

SearchResponse redirectUri.

Property Value

Type	Description
string

results

public results: google.cloud.retail.v2.SearchResponse.ISearchResult[];

SearchResponse results.

Property Value

Type	Description
google.cloud.retail.v2.SearchResponse.ISearchResult[]

totalSize

public totalSize: number;

SearchResponse totalSize.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.ISearchResponse): google.cloud.retail.v2.SearchResponse;

Creates a new SearchResponse instance using the specified properties.

Parameter

Name	Description
properties	`ISearchResponse` Properties to set

Returns

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

decode(reader, length)

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

Decodes a SearchResponse 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.SearchResponse	SearchResponse

decodeDelimited(reader)

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

Decodes a SearchResponse 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.SearchResponse	SearchResponse

encode(message, writer)

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

Encodes the specified SearchResponse message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`ISearchResponse` SearchResponse 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.SearchResponse;

Creates a SearchResponse 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.SearchResponse	SearchResponse

toJSON()

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

Converts this SearchResponse to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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