Class: Google::Cloud::Retail::V2::AttributesConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/catalog.rb

Overview

Catalog level attribute config.

Defined Under Namespace

Classes: CatalogAttributesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_config_level ⇒ ::Google::Cloud::Retail::V2::AttributeConfigLevel (readonly)

Returns Output only. The AttributeConfigLevel used for this catalog.

Returns:



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 408

class AttributesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CatalogAttribute]
  class CatalogAttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#catalog_attributes ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}

Returns 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.



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 408

class AttributesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CatalogAttribute]
  class CatalogAttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns 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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 408

class AttributesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::CatalogAttribute]
  class CatalogAttributesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end