Package com.google.cloud.retail.v2alpha

Interface CatalogAttribute.FacetConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CatalogAttribute.FacetConfig, CatalogAttribute.FacetConfig.Builder
Enclosing class:
CatalogAttribute
public static interface CatalogAttribute.FacetConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFacetIntervalsList

      List<Interval> getFacetIntervalsList()
       If you don't set the facet
 [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.intervals]
 in the request to a numerical attribute, then we use the computed
 intervals with rounded bounds obtained from all its product numerical
 attribute values. The computed intervals might not be ideal for some
 attributes. Therefore, we give you the option to overwrite them with the
 facet_intervals field. The maximum of facet intervals per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 40.
 Each interval must have a lower bound or an upper bound. If both bounds
 are provided, then the lower bound must be smaller or equal than the
 upper bound.
      repeated .google.cloud.retail.v2alpha.Interval facet_intervals = 1;

    • getFacetIntervals

      Interval getFacetIntervals(int index)
       If you don't set the facet
 [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.intervals]
 in the request to a numerical attribute, then we use the computed
 intervals with rounded bounds obtained from all its product numerical
 attribute values. The computed intervals might not be ideal for some
 attributes. Therefore, we give you the option to overwrite them with the
 facet_intervals field. The maximum of facet intervals per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 40.
 Each interval must have a lower bound or an upper bound. If both bounds
 are provided, then the lower bound must be smaller or equal than the
 upper bound.
      repeated .google.cloud.retail.v2alpha.Interval facet_intervals = 1;

    • getFacetIntervalsCount

      int getFacetIntervalsCount()
       If you don't set the facet
 [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.intervals]
 in the request to a numerical attribute, then we use the computed
 intervals with rounded bounds obtained from all its product numerical
 attribute values. The computed intervals might not be ideal for some
 attributes. Therefore, we give you the option to overwrite them with the
 facet_intervals field. The maximum of facet intervals per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 40.
 Each interval must have a lower bound or an upper bound. If both bounds
 are provided, then the lower bound must be smaller or equal than the
 upper bound.
      repeated .google.cloud.retail.v2alpha.Interval facet_intervals = 1;

    • getFacetIntervalsOrBuilderList

      List<? extends IntervalOrBuilder> getFacetIntervalsOrBuilderList()
       If you don't set the facet
 [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.intervals]
 in the request to a numerical attribute, then we use the computed
 intervals with rounded bounds obtained from all its product numerical
 attribute values. The computed intervals might not be ideal for some
 attributes. Therefore, we give you the option to overwrite them with the
 facet_intervals field. The maximum of facet intervals per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 40.
 Each interval must have a lower bound or an upper bound. If both bounds
 are provided, then the lower bound must be smaller or equal than the
 upper bound.
      repeated .google.cloud.retail.v2alpha.Interval facet_intervals = 1;

    • getFacetIntervalsOrBuilder

      IntervalOrBuilder getFacetIntervalsOrBuilder(int index)
       If you don't set the facet
 [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.intervals]
 in the request to a numerical attribute, then we use the computed
 intervals with rounded bounds obtained from all its product numerical
 attribute values. The computed intervals might not be ideal for some
 attributes. Therefore, we give you the option to overwrite them with the
 facet_intervals field. The maximum of facet intervals per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 40.
 Each interval must have a lower bound or an upper bound. If both bounds
 are provided, then the lower bound must be smaller or equal than the
 upper bound.
      repeated .google.cloud.retail.v2alpha.Interval facet_intervals = 1;

    • getIgnoredFacetValuesList

      List<CatalogAttribute.FacetConfig.IgnoredFacetValues> getIgnoredFacetValuesList()
       Each instance represents a list of attribute values to ignore as facet
 values for a specific time range. The maximum number of instances per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 25.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

    • getIgnoredFacetValues

      CatalogAttribute.FacetConfig.IgnoredFacetValues getIgnoredFacetValues(int index)
       Each instance represents a list of attribute values to ignore as facet
 values for a specific time range. The maximum number of instances per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 25.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

    • getIgnoredFacetValuesCount

      int getIgnoredFacetValuesCount()
       Each instance represents a list of attribute values to ignore as facet
 values for a specific time range. The maximum number of instances per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 25.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

    • getIgnoredFacetValuesOrBuilderList

      List<? extends CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder> getIgnoredFacetValuesOrBuilderList()
       Each instance represents a list of attribute values to ignore as facet
 values for a specific time range. The maximum number of instances per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 25.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

    • getIgnoredFacetValuesOrBuilder

      CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder getIgnoredFacetValuesOrBuilder(int index)
       Each instance represents a list of attribute values to ignore as facet
 values for a specific time range. The maximum number of instances per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 25.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

    • getMergedFacetValuesList

      List<CatalogAttribute.FacetConfig.MergedFacetValue> getMergedFacetValuesList()
       Each instance replaces a list of facet values by a merged facet
 value. If a facet value is not in any list, then it will stay the same.
 To avoid conflicts, only paths of length 1 are accepted. In other words,
 if "dark_blue" merged into "BLUE", then the latter can't merge into
 "blues" because this would create a path of length 2. The maximum number
 of instances of MergedFacetValue per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 100.
 This feature is available only for textual custom attributes.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

    • getMergedFacetValues

      CatalogAttribute.FacetConfig.MergedFacetValue getMergedFacetValues(int index)
       Each instance replaces a list of facet values by a merged facet
 value. If a facet value is not in any list, then it will stay the same.
 To avoid conflicts, only paths of length 1 are accepted. In other words,
 if "dark_blue" merged into "BLUE", then the latter can't merge into
 "blues" because this would create a path of length 2. The maximum number
 of instances of MergedFacetValue per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 100.
 This feature is available only for textual custom attributes.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

    • getMergedFacetValuesCount

      int getMergedFacetValuesCount()
       Each instance replaces a list of facet values by a merged facet
 value. If a facet value is not in any list, then it will stay the same.
 To avoid conflicts, only paths of length 1 are accepted. In other words,
 if "dark_blue" merged into "BLUE", then the latter can't merge into
 "blues" because this would create a path of length 2. The maximum number
 of instances of MergedFacetValue per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 100.
 This feature is available only for textual custom attributes.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

    • getMergedFacetValuesOrBuilderList

      List<? extends CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder> getMergedFacetValuesOrBuilderList()
       Each instance replaces a list of facet values by a merged facet
 value. If a facet value is not in any list, then it will stay the same.
 To avoid conflicts, only paths of length 1 are accepted. In other words,
 if "dark_blue" merged into "BLUE", then the latter can't merge into
 "blues" because this would create a path of length 2. The maximum number
 of instances of MergedFacetValue per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 100.
 This feature is available only for textual custom attributes.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

    • getMergedFacetValuesOrBuilder

      CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder getMergedFacetValuesOrBuilder(int index)
       Each instance replaces a list of facet values by a merged facet
 value. If a facet value is not in any list, then it will stay the same.
 To avoid conflicts, only paths of length 1 are accepted. In other words,
 if "dark_blue" merged into "BLUE", then the latter can't merge into
 "blues" because this would create a path of length 2. The maximum number
 of instances of MergedFacetValue per
 [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] is 100.
 This feature is available only for textual custom attributes.
      repeated .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

    • hasMergedFacet

      boolean hasMergedFacet()
       Use this field only if you want to merge a facet key into another facet
 key.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
      Returns:
      Whether the mergedFacet field is set.

    • getMergedFacet

      CatalogAttribute.FacetConfig.MergedFacet getMergedFacet()
       Use this field only if you want to merge a facet key into another facet
 key.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
      Returns:
      The mergedFacet.

    • getMergedFacetOrBuilder

      CatalogAttribute.FacetConfig.MergedFacetOrBuilder getMergedFacetOrBuilder()
       Use this field only if you want to merge a facet key into another facet
 key.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;

    • hasRerankConfig

      boolean hasRerankConfig()
       Set this field only if you want to rerank based on facet values engaged
 by the user for the current key. This option is only possible for custom
 facetable textual keys.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
      Returns:
      Whether the rerankConfig field is set.

    • getRerankConfig

      CatalogAttribute.FacetConfig.RerankConfig getRerankConfig()
       Set this field only if you want to rerank based on facet values engaged
 by the user for the current key. This option is only possible for custom
 facetable textual keys.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
      Returns:
      The rerankConfig.

    • getRerankConfigOrBuilder

      CatalogAttribute.FacetConfig.RerankConfigOrBuilder getRerankConfigOrBuilder()
       Set this field only if you want to rerank based on facet values engaged
 by the user for the current key. This option is only possible for custom
 facetable textual keys.
      .google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;