CatalogAttribute

google.cloud.retail.v2. CatalogAttribute

Represents a CatalogAttribute.

Constructor

new CatalogAttribute(propertiesopt)

Constructs a new CatalogAttribute.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2.ICatalogAttribute <optional>

Properties to set
Implements:
  • ICatalogAttribute

Members

dynamicFacetableOption

CatalogAttribute dynamicFacetableOption.

exactSearchableOption

CatalogAttribute exactSearchableOption.

inUse

CatalogAttribute inUse.

indexableOption

CatalogAttribute indexableOption.

key

CatalogAttribute key.

retrievableOption

CatalogAttribute retrievableOption.

searchableOption

CatalogAttribute searchableOption.

type

CatalogAttribute type.

AttributeType

AttributeType enum.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN value
TEXTUAL number

TEXTUAL value
NUMERICAL number

NUMERICAL value

DynamicFacetableOption

DynamicFacetableOption enum.

Properties:
Name Type Description
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED number

DYNAMIC_FACETABLE_OPTION_UNSPECIFIED value
DYNAMIC_FACETABLE_ENABLED number

DYNAMIC_FACETABLE_ENABLED value
DYNAMIC_FACETABLE_DISABLED number

DYNAMIC_FACETABLE_DISABLED value

ExactSearchableOption

ExactSearchableOption enum.

Properties:
Name Type Description
EXACT_SEARCHABLE_OPTION_UNSPECIFIED number

EXACT_SEARCHABLE_OPTION_UNSPECIFIED value
EXACT_SEARCHABLE_ENABLED number

EXACT_SEARCHABLE_ENABLED value
EXACT_SEARCHABLE_DISABLED number

EXACT_SEARCHABLE_DISABLED value

IndexableOption

IndexableOption enum.

Properties:
Name Type Description
INDEXABLE_OPTION_UNSPECIFIED number

INDEXABLE_OPTION_UNSPECIFIED value
INDEXABLE_ENABLED number

INDEXABLE_ENABLED value
INDEXABLE_DISABLED number

INDEXABLE_DISABLED value

RetrievableOption

RetrievableOption enum.

Properties:
Name Type Description
RETRIEVABLE_OPTION_UNSPECIFIED number

RETRIEVABLE_OPTION_UNSPECIFIED value
RETRIEVABLE_ENABLED number

RETRIEVABLE_ENABLED value
RETRIEVABLE_DISABLED number

RETRIEVABLE_DISABLED value

SearchableOption

SearchableOption enum.

Properties:
Name Type Description
SEARCHABLE_OPTION_UNSPECIFIED number

SEARCHABLE_OPTION_UNSPECIFIED value
SEARCHABLE_ENABLED number

SEARCHABLE_ENABLED value
SEARCHABLE_DISABLED number

SEARCHABLE_DISABLED value

Methods

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

Converts this CatalogAttribute to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.retail.v2.CatalogAttribute}

Creates a new CatalogAttribute instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.retail.v2.ICatalogAttribute <optional>

Properties to set
Returns:
Type Description
google.cloud.retail.v2.CatalogAttribute

CatalogAttribute instance

(static) decode(reader, lengthopt) → {google.cloud.retail.v2.CatalogAttribute}

Decodes a CatalogAttribute 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.v2.CatalogAttribute

CatalogAttribute
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.v2.CatalogAttribute}

Decodes a CatalogAttribute 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.v2.CatalogAttribute

CatalogAttribute
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 CatalogAttribute message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.ICatalogAttribute

CatalogAttribute 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 CatalogAttribute message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.ICatalogAttribute

CatalogAttribute 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.v2.CatalogAttribute}

Creates a CatalogAttribute 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.v2.CatalogAttribute

CatalogAttribute

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CatalogAttribute

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 CatalogAttribute message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.retail.v2.CatalogAttribute

CatalogAttribute
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a CatalogAttribute 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