Class protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult (1.2.0)

Represents a SearchResult.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult);

Constructs a new SearchResult.

Parameter
NameDescription
properties ISearchResult

Properties to set

Properties

document

public document?: (google.cloud.discoveryengine.v1alpha.IDocument|null);

SearchResult document.

id

public id: string;

SearchResult id.

modelScores

public modelScores: { [k: string]: google.cloud.discoveryengine.v1alpha.IDoubleList };

SearchResult modelScores.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult;

Creates a new SearchResult instance using the specified properties.

Parameter
NameDescription
properties ISearchResult

Properties to set

Returns
TypeDescription
SearchResult

SearchResult instance

decode(reader, length)

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

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

SearchResult

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SearchResult

SearchResult

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SearchResult message. Does not implicitly messages.

Parameters
NameDescription
message ISearchResult

SearchResult 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.v1alpha.SearchResponse.ISearchResult, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISearchResult

SearchResult 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.v1alpha.SearchResponse.SearchResult;

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

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

Plain object

Returns
TypeDescription
SearchResult

SearchResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchResult

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SearchResult

SearchResult

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