FacetKey

google.cloud.retail.v2alpha.SearchRequest.FacetSpec. FacetKey

Represents a FacetKey.

Constructor

new FacetKey(propertiesopt)

Constructs a new FacetKey.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2alpha.SearchRequest.FacetSpec.IFacetKey <optional>

Properties to set

Implements:
  • IFacetKey

Members

caseInsensitive

FacetKey caseInsensitive.

contains

FacetKey contains.

intervals

FacetKey intervals.

key

FacetKey key.

orderBy

FacetKey orderBy.

prefixes

FacetKey prefixes.

query

FacetKey query.

restrictedValues

FacetKey restrictedValues.

returnMinMax

FacetKey returnMinMax.

Methods

toJSON() → {Object.<string, *>}

Converts this FacetKey to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey}

Creates a new FacetKey instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2alpha.SearchRequest.FacetSpec.IFacetKey <optional>

Properties to set

Returns:
Type Description
google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

FacetKey instance

(static) decode(reader, lengthopt) → {google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey}

Decodes a FacetKey message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

FacetKey

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

FacetKey

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified FacetKey message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.SearchRequest.FacetSpec.IFacetKey

FacetKey message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.SearchRequest.FacetSpec.IFacetKey

FacetKey message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey}

Creates a FacetKey message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

FacetKey

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FacetKey

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

FacetKey

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a FacetKey message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not