Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.retail.v2alpha.SearchRequest.FacetSpec (2.1.1)

Represents a FacetSpec.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2alpha.SearchRequest.IFacetSpec);

Constructs a new FacetSpec.

Parameter

Name	Description
properties	`IFacetSpec` Properties to set

Properties

enableDynamicPosition

public enableDynamicPosition: boolean;

FacetSpec enableDynamicPosition.

excludedFilterKeys

public excludedFilterKeys: string[];

FacetSpec excludedFilterKeys.

facetKey

public facetKey?: (google.cloud.retail.v2alpha.SearchRequest.FacetSpec.IFacetKey|null);

FacetSpec facetKey.

limit

public limit: number;

FacetSpec limit.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.SearchRequest.IFacetSpec): google.cloud.retail.v2alpha.SearchRequest.FacetSpec;

Creates a new FacetSpec instance using the specified properties.

Parameter

Name	Description
properties	`IFacetSpec` Properties to set

Returns

Type	Description
google.cloud.retail.v2alpha.SearchRequest.FacetSpec	FacetSpec instance

decode(reader, length)

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

Decodes a FacetSpec 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.v2alpha.SearchRequest.FacetSpec	FacetSpec

decodeDelimited(reader)

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

Decodes a FacetSpec 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.v2alpha.SearchRequest.FacetSpec	FacetSpec

encode(message, writer)

public static encode(message: google.cloud.retail.v2alpha.SearchRequest.IFacetSpec, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FacetSpec message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IFacetSpec` FacetSpec 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.v2alpha.SearchRequest.FacetSpec;

Creates a FacetSpec 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.v2alpha.SearchRequest.FacetSpec	FacetSpec

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FacetSpec

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.retail.v2alpha.SearchRequest.FacetSpec` FacetSpec
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 FacetSpec 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