Class protos.google.cloud.retail.v2.SearchResponse.Facet.FacetValue (1.2.2)

Represents a FacetValue.

Package

@google-cloud/retail!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2.SearchResponse.Facet.IFacetValue);

Constructs a new FacetValue.

Parameter

Name	Description
properties	`IFacetValue` Properties to set

Properties

count

public count: (number|Long|string);

FacetValue count.

Property Value

Type	Description
(number\|Long\|string)

facetValue

public facetValue?: ("value"|"interval");

FacetValue facetValue.

Property Value

Type	Description
("value"\|"interval")

interval

public interval?: (google.cloud.retail.v2.IInterval|null);

FacetValue interval.

Property Value

Type	Description
(google.cloud.retail.v2.IInterval\|null)

value

public value?: (string|null);

FacetValue value.

Property Value

Type	Description
(string\|null)

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.SearchResponse.Facet.IFacetValue): google.cloud.retail.v2.SearchResponse.Facet.FacetValue;

Creates a new FacetValue instance using the specified properties.

Parameter

Name	Description
properties	`IFacetValue` Properties to set

Returns

Type	Description
google.cloud.retail.v2.SearchResponse.Facet.FacetValue	FacetValue instance

decode(reader, length)

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

Decodes a FacetValue 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.SearchResponse.Facet.FacetValue	FacetValue

decodeDelimited(reader)

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

Decodes a FacetValue 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.SearchResponse.Facet.FacetValue	FacetValue

encode(message, writer)

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

Encodes the specified FacetValue message. Does not implicitly messages.

Parameters

Name	Description
message	`IFacetValue` FacetValue 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.SearchResponse.Facet.IFacetValue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IFacetValue` FacetValue 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.SearchResponse.Facet.FacetValue;

Creates a FacetValue 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.SearchResponse.Facet.FacetValue	FacetValue

toJSON()

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

Converts this FacetValue to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.retail.v2.SearchResponse.Facet.FacetValue` FacetValue
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 FacetValue 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