Package com.google.cloud.retail.v2alpha

Interface AttributesConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AttributesConfig, AttributesConfig.Builder
@Generated public interface AttributesConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Required. Immutable. The fully qualified resource name of the attribute
 config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. Immutable. The fully qualified resource name of the attribute
 config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.

    • getCatalogAttributesCount

      int getCatalogAttributesCount()
       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.
      map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

    • containsCatalogAttributes

      boolean containsCatalogAttributes(String key)
       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.
      map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

    • getCatalogAttributes

      @Deprecated Map<String,CatalogAttribute> getCatalogAttributes()
      Deprecated.
      Use getCatalogAttributesMap() instead.

    • getCatalogAttributesMap

      Map<String,CatalogAttribute> getCatalogAttributesMap()
       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.
      map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

    • getCatalogAttributesOrDefault

      CatalogAttribute getCatalogAttributesOrDefault(String key, CatalogAttribute defaultValue)
       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.
      map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

    • getCatalogAttributesOrThrow

      CatalogAttribute getCatalogAttributesOrThrow(String key)
       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.
      map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

    • getAttributeConfigLevelValue

      int getAttributeConfigLevelValue()
       Output only. The
 [AttributeConfigLevel][google.cloud.retail.v2alpha.AttributeConfigLevel]
 used for this catalog.
      .google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for attributeConfigLevel.

    • getAttributeConfigLevel

      AttributeConfigLevel getAttributeConfigLevel()
       Output only. The
 [AttributeConfigLevel][google.cloud.retail.v2alpha.AttributeConfigLevel]
 used for this catalog.
      .google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The attributeConfigLevel.