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.v2.SearchRequest.FacetSpec.FacetKey (1.5.0)

Represents a FacetKey.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2.SearchRequest.FacetSpec.IFacetKey);

Constructs a new FacetKey.

Parameter

Name	Description
properties	`IFacetKey` Properties to set

Properties

contains

public contains: string[];

FacetKey contains.

intervals

public intervals: google.cloud.retail.v2.IInterval[];

FacetKey intervals.

key

public key: string;

FacetKey key.

orderBy

public orderBy: string;

FacetKey orderBy.

prefixes

public prefixes: string[];

FacetKey prefixes.

query

public query: string;

FacetKey query.

restrictedValues

public restrictedValues: string[];

FacetKey restrictedValues.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.SearchRequest.FacetSpec.IFacetKey): google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey;

Creates a new FacetKey instance using the specified properties.

Parameter

Name	Description
properties	`IFacetKey` Properties to set

Returns

Type	Description
google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey	FacetKey instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified FacetKey message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IFacetKey` FacetKey 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.FacetSpec.FacetKey;

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

toJSON()

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

Converts this FacetKey to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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