Class protos.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams (1.9.0)

Represents a SearchParams.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.ISearchParams);

Constructs a new SearchParams.

Parameter
Name Description
properties ISearchParams

Properties to set

Properties

boostSpec

public boostSpec?: (google.cloud.discoveryengine.v1.SearchRequest.IBoostSpec|null);

SearchParams boostSpec.

dataStoreSpecs

public dataStoreSpecs: google.cloud.discoveryengine.v1.SearchRequest.IDataStoreSpec[];

SearchParams dataStoreSpecs.

filter

public filter: string;

SearchParams filter.

maxReturnResults

public maxReturnResults: number;

SearchParams maxReturnResults.

orderBy

public orderBy: string;

SearchParams orderBy.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.ISearchParams): google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams;

Creates a new SearchParams instance using the specified properties.

Parameter
Name Description
properties ISearchParams

Properties to set

Returns
Type Description
SearchParams

SearchParams instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams;

Decodes a SearchParams message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
SearchParams

SearchParams

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SearchParams

SearchParams

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.ISearchParams, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SearchParams message. Does not implicitly messages.

Parameters
Name Description
message ISearchParams

SearchParams 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.discoveryengine.v1.AnswerQueryRequest.SearchSpec.ISearchParams, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISearchParams

SearchParams 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.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams;

Creates a SearchParams 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
SearchParams

SearchParams

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchParams

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this SearchParams to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SearchParams

SearchParams

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