Package com.google.cloud.retail.v2alpha

Interface CatalogAttributeOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    CatalogAttribute.DynamicFacetableOption
    getDynamicFacetableOption()
    If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
    int
    getDynamicFacetableOptionValue()
    If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
    CatalogAttribute.ExactSearchableOption
    getExactSearchableOption()
    If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
    int
    getExactSearchableOptionValue()
    If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
    CatalogAttribute.FacetConfig
    getFacetConfig()
    Contains facet options.
    CatalogAttribute.FacetConfigOrBuilder
    getFacetConfigOrBuilder()
    Contains facet options.
    CatalogAttribute.IndexableOption
    getIndexableOption()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
    int
    getIndexableOptionValue()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
    boolean
    getInUse()
    Output only.
    String
    getKey()
    Required.
    com.google.protobuf.ByteString
    getKeyBytes()
    Required.
    RecommendationsFilteringOption
    getRecommendationsFilteringOption()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations.
    int
    getRecommendationsFilteringOptionValue()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations.
    CatalogAttribute.RetrievableOption
    getRetrievableOption()
    If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results.
    int
    getRetrievableOptionValue()
    If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results.
    CatalogAttribute.SearchableOption
    getSearchableOption()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
    int
    getSearchableOptionValue()
    When [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level] is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
    CatalogAttribute.AttributeType
    getType()
    Output only.
    int
    getTypeValue()
    Output only.
    boolean
    hasFacetConfig()
    Contains facet options.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getKey

      String getKey()
       Required. Attribute name.
 For example: `color`, `brands`, `attributes.custom_attribute`, such as
 `attributes.xyz`.
 To be indexable, the attribute name can contain only alpha-numeric
 characters and underscores. For example, an attribute named
 `attributes.abc_xyz` can be indexed, but an attribute named
 `attributes.abc-xyz` cannot be indexed.

 If the attribute key starts with `attributes.`, then the attribute is a
 custom attribute. Attributes such as `brands`, `patterns`, and `title` are
 built-in and called system attributes.
      string key = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       Required. Attribute name.
 For example: `color`, `brands`, `attributes.custom_attribute`, such as
 `attributes.xyz`.
 To be indexable, the attribute name can contain only alpha-numeric
 characters and underscores. For example, an attribute named
 `attributes.abc_xyz` can be indexed, but an attribute named
 `attributes.abc-xyz` cannot be indexed.

 If the attribute key starts with `attributes.`, then the attribute is a
 custom attribute. Attributes such as `brands`, `patterns`, and `title` are
 built-in and called system attributes.
      string key = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for key.

    • getInUse

      boolean getInUse()
       Output only. Indicates whether this attribute has been used by any
 products. `True` if at least one
 [Product][google.cloud.retail.v2alpha.Product] is using this attribute in
 [Product.attributes][google.cloud.retail.v2alpha.Product.attributes].
 Otherwise, this field is `False`.

 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] can be
 pre-loaded by using
 [CatalogService.AddCatalogAttribute][google.cloud.retail.v2alpha.CatalogService.AddCatalogAttribute]
 or
 [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2alpha.CatalogService.UpdateAttributesConfig]
 APIs. This field is `False` for pre-loaded
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s.

 Only pre-loaded [catalog
 attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are neither
 in use by products nor predefined can be deleted. [Catalog
 attributes][google.cloud.retail.v2alpha.CatalogAttribute] that are
 either in use by products or are predefined attributes cannot be deleted;
 however, their configuration properties will reset to default values upon
 removal request.

 After catalog changes, it takes about 10 minutes for this field to update.
      bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The inUse.

    • getTypeValue

      int getTypeValue()
       Output only. The type of this attribute. This is derived from the attribute
 in [Product.attributes][google.cloud.retail.v2alpha.Product.attributes].
      .google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      CatalogAttribute.AttributeType getType()
       Output only. The type of this attribute. This is derived from the attribute
 in [Product.attributes][google.cloud.retail.v2alpha.Product.attributes].
      .google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The type.

    • getIndexableOptionValue

      int getIndexableOptionValue()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
 are indexed so that it can be filtered, faceted, or boosted in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 Must be specified when
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
      Returns:
      The enum numeric value on the wire for indexableOption.

    • getIndexableOption

      CatalogAttribute.IndexableOption getIndexableOption()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
 are indexed so that it can be filtered, faceted, or boosted in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 Must be specified when
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
      Returns:
      The indexableOption.

    • getDynamicFacetableOptionValue

      int getDynamicFacetableOptionValue()
       If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
 facet. Could only be DYNAMIC_FACETABLE_DISABLED if
 [CatalogAttribute.indexable_option][google.cloud.retail.v2alpha.CatalogAttribute.indexable_option]
 is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.

 Must be specified, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
      Returns:
      The enum numeric value on the wire for dynamicFacetableOption.

    • getDynamicFacetableOption

      CatalogAttribute.DynamicFacetableOption getDynamicFacetableOption()
       If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
 facet. Could only be DYNAMIC_FACETABLE_DISABLED if
 [CatalogAttribute.indexable_option][google.cloud.retail.v2alpha.CatalogAttribute.indexable_option]
 is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.

 Must be specified, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
      Returns:
      The dynamicFacetableOption.

    • getSearchableOptionValue

      int getSearchableOptionValue()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
 are searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 If SEARCHABLE_ENABLED but attribute type is numerical, attribute values
 will not be searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search],
 as there are no text values associated to numerical attributes.

 Must be specified, when
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
      Returns:
      The enum numeric value on the wire for searchableOption.

    • getSearchableOption

      CatalogAttribute.SearchableOption getSearchableOption()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
 are searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 If SEARCHABLE_ENABLED but attribute type is numerical, attribute values
 will not be searchable by text queries in
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search],
 as there are no text values associated to numerical attributes.

 Must be specified, when
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      .google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
      Returns:
      The searchableOption.

    • getRecommendationsFilteringOptionValue

      int getRecommendationsFilteringOptionValue()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
 attribute values are filterable for recommendations.
 This option works for categorical features only,
 does not work for numerical features, inventory filtering.
      .google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
      Returns:
      The enum numeric value on the wire for recommendationsFilteringOption.

    • getRecommendationsFilteringOption

      RecommendationsFilteringOption getRecommendationsFilteringOption()
       When
 [AttributesConfig.attribute_config_level][google.cloud.retail.v2alpha.AttributesConfig.attribute_config_level]
 is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
 attribute values are filterable for recommendations.
 This option works for categorical features only,
 does not work for numerical features, inventory filtering.
      .google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
      Returns:
      The recommendationsFilteringOption.

    • getExactSearchableOptionValue

      int getExactSearchableOptionValue()
       If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
 This property only applies to textual custom attributes and requires
 indexable set to enabled to enable exact-searchable. If unset, the server
 behavior defaults to
 [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
      .google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
      Returns:
      The enum numeric value on the wire for exactSearchableOption.

    • getExactSearchableOption

      CatalogAttribute.ExactSearchableOption getExactSearchableOption()
       If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
 This property only applies to textual custom attributes and requires
 indexable set to enabled to enable exact-searchable. If unset, the server
 behavior defaults to
 [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
      .google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
      Returns:
      The exactSearchableOption.

    • getRetrievableOptionValue

      int getRetrievableOptionValue()
       If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
 results. If unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
      .google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
      Returns:
      The enum numeric value on the wire for retrievableOption.

    • getRetrievableOption

      CatalogAttribute.RetrievableOption getRetrievableOption()
       If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
 results. If unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
      .google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
      Returns:
      The retrievableOption.

    • hasFacetConfig

      boolean hasFacetConfig()
       Contains facet options.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
      Returns:
      Whether the facetConfig field is set.

    • getFacetConfig

      CatalogAttribute.FacetConfig getFacetConfig()
       Contains facet options.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;
      Returns:
      The facetConfig.

    • getFacetConfigOrBuilder

      CatalogAttribute.FacetConfigOrBuilder getFacetConfigOrBuilder()
       Contains facet options.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;