Retail V2 API - Class Google::Cloud::Retail::V2::AttributesConfig (v0.20.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::AttributesConfig.

Catalog level attribute config.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attribute_config_level

def attribute_config_level() -> ::Google::Cloud::Retail::V2::AttributeConfigLevel
Returns

#catalog_attributes

def catalog_attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}) — Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

    The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

    The maximum number of catalog attributes allowed in a request is 1000.

#catalog_attributes=

def catalog_attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}) — Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

    The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

    The maximum number of catalog attributes allowed in a request is 1000.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}) — Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

    The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

    The maximum number of catalog attributes allowed in a request is 1000.

#name

def name() -> ::String
Returns
  • (::String) — Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig
Returns
  • (::String) — Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig