Class protos.google.cloud.discoveryengine.v1beta.SearchResponse (1.0.0)

Represents a SearchResponse.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.ISearchResponse);

Constructs a new SearchResponse.

Parameter
NameDescription
properties ISearchResponse

Properties to set

Properties

appliedControls

public appliedControls: string[];

SearchResponse appliedControls.

attributionToken

public attributionToken: string;

SearchResponse attributionToken.

correctedQuery

public correctedQuery: string;

SearchResponse correctedQuery.

facets

public facets: google.cloud.discoveryengine.v1beta.SearchResponse.IFacet[];

SearchResponse facets.

guidedSearchResult

public guidedSearchResult?: (google.cloud.discoveryengine.v1beta.SearchResponse.IGuidedSearchResult|null);

SearchResponse guidedSearchResult.

nextPageToken

public nextPageToken: string;

SearchResponse nextPageToken.

redirectUri

public redirectUri: string;

SearchResponse redirectUri.

results

public results: google.cloud.discoveryengine.v1beta.SearchResponse.ISearchResult[];

SearchResponse results.

summary

public summary?: (google.cloud.discoveryengine.v1beta.SearchResponse.ISummary|null);

SearchResponse summary.

totalSize

public totalSize: number;

SearchResponse totalSize.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.ISearchResponse): google.cloud.discoveryengine.v1beta.SearchResponse;

Creates a new SearchResponse instance using the specified properties.

Parameter
NameDescription
properties ISearchResponse

Properties to set

Returns
TypeDescription
SearchResponse

SearchResponse instance

decode(reader, length)

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

Decodes a SearchResponse message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SearchResponse

SearchResponse

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SearchResponse

SearchResponse

encode(message, writer)

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

Encodes the specified SearchResponse message. Does not implicitly messages.

Parameters
NameDescription
message ISearchResponse

SearchResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.ISearchResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISearchResponse

SearchResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.SearchResponse;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SearchResponse

SearchResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchResponse

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this SearchResponse to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SearchResponse

SearchResponse

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a SearchResponse message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not