Class protos.google.cloud.retail.v2.SearchRequest (3.1.0)

Represents a SearchRequest.

Package

Constructors

(constructor)(properties)

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

Constructs a new SearchRequest.

Parameter
Name	Description
`properties`	`ISearchRequest` Properties to set

Properties

_spellCorrectionSpec

public _spellCorrectionSpec?: "spellCorrectionSpec";

SearchRequest _spellCorrectionSpec.

boostSpec

public boostSpec?: (google.cloud.retail.v2.SearchRequest.IBoostSpec|null);

SearchRequest boostSpec.

branch

public branch: string;

SearchRequest branch.

canonicalFilter

public canonicalFilter: string;

SearchRequest canonicalFilter.

dynamicFacetSpec

public dynamicFacetSpec?: (google.cloud.retail.v2.SearchRequest.IDynamicFacetSpec|null);

SearchRequest dynamicFacetSpec.

entity

public entity: string;

SearchRequest entity.

facetSpecs

public facetSpecs: google.cloud.retail.v2.SearchRequest.IFacetSpec[];

SearchRequest facetSpecs.

filter

public filter: string;

SearchRequest filter.

labels

public labels: { [k: string]: string };

SearchRequest labels.

offset

public offset: number;

SearchRequest offset.

orderBy

public orderBy: string;

SearchRequest orderBy.

pageCategories

public pageCategories: string[];

SearchRequest pageCategories.

pageSize

public pageSize: number;

SearchRequest pageSize.

pageToken

public pageToken: string;

SearchRequest pageToken.

personalizationSpec

public personalizationSpec?: (google.cloud.retail.v2.SearchRequest.IPersonalizationSpec|null);

SearchRequest personalizationSpec.

placement

public placement: string;

SearchRequest placement.

query

public query: string;

SearchRequest query.

queryExpansionSpec

public queryExpansionSpec?: (google.cloud.retail.v2.SearchRequest.IQueryExpansionSpec|null);

SearchRequest queryExpansionSpec.

searchMode

public searchMode: (google.cloud.retail.v2.SearchRequest.SearchMode|keyof typeof google.cloud.retail.v2.SearchRequest.SearchMode);

SearchRequest searchMode.

spellCorrectionSpec

public spellCorrectionSpec?: (google.cloud.retail.v2.SearchRequest.ISpellCorrectionSpec|null);

SearchRequest spellCorrectionSpec.

userInfo

public userInfo?: (google.cloud.retail.v2.IUserInfo|null);

SearchRequest userInfo.

variantRollupKeys

public variantRollupKeys: string[];

SearchRequest variantRollupKeys.

visitorId

public visitorId: string;

SearchRequest visitorId.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.ISearchRequest): google.cloud.retail.v2.SearchRequest;

Creates a new SearchRequest instance using the specified properties.

Parameter
Name	Description
`properties`	`ISearchRequest` Properties to set

Returns
Type	Description
`SearchRequest`	SearchRequest instance

decode(reader, length)

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

Decodes a SearchRequest 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
`SearchRequest`	SearchRequest

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`SearchRequest`	SearchRequest

encode(message, writer)

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

Encodes the specified SearchRequest message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`ISearchRequest` SearchRequest 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.SearchRequest;

Creates a SearchRequest 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
`SearchRequest`	SearchRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchRequest

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`SearchRequest` SearchRequest
`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 SearchRequest 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