public static interface CatalogAttribute.FacetConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
Interval |
getFacetIntervals(int index)
If you don't set the facet
[SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.
|
int |
getFacetIntervalsCount()
If you don't set the facet
[SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.
|
List<Interval> |
getFacetIntervalsList()
If you don't set the facet
[SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.
|
IntervalOrBuilder |
getFacetIntervalsOrBuilder(int index)
If you don't set the facet
[SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.
|
List<? extends IntervalOrBuilder> |
getFacetIntervalsOrBuilderList()
If you don't set the facet
[SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.
|
CatalogAttribute.FacetConfig.IgnoredFacetValues |
getIgnoredFacetValues(int index)
Each instance represents a list of attribute values to ignore as facet
values for a specific time range.
|
int |
getIgnoredFacetValuesCount()
Each instance represents a list of attribute values to ignore as facet
values for a specific time range.
|
List<CatalogAttribute.FacetConfig.IgnoredFacetValues> |
getIgnoredFacetValuesList()
Each instance represents a list of attribute values to ignore as facet
values for a specific time range.
|
CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder |
getIgnoredFacetValuesOrBuilder(int index)
Each instance represents a list of attribute values to ignore as facet
values for a specific time range.
|
List<? extends CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder> |
getIgnoredFacetValuesOrBuilderList()
Each instance represents a list of attribute values to ignore as facet
values for a specific time range.
|
CatalogAttribute.FacetConfig.MergedFacet |
getMergedFacet()
Use this field only if you want to merge a facet key into another facet
key.
|
CatalogAttribute.FacetConfig.MergedFacetOrBuilder |
getMergedFacetOrBuilder()
Use this field only if you want to merge a facet key into another facet
key.
|
CatalogAttribute.FacetConfig.MergedFacetValue |
getMergedFacetValues(int index)
Each instance replaces a list of facet values by a merged facet
value.
|
int |
getMergedFacetValuesCount()
Each instance replaces a list of facet values by a merged facet
value.
|
List<CatalogAttribute.FacetConfig.MergedFacetValue> |
getMergedFacetValuesList()
Each instance replaces a list of facet values by a merged facet
value.
|
CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder |
getMergedFacetValuesOrBuilder(int index)
Each instance replaces a list of facet values by a merged facet
value.
|
List<? extends CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder> |
getMergedFacetValuesOrBuilderList()
Each instance replaces a list of facet values by a merged facet
value.
|
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.
|
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.
|
boolean |
hasMergedFacet()
Use this field only if you want to merge a facet key into another facet
key.
|
boolean |
hasRerankConfig()
Set this field only if you want to rerank based on facet values engaged
by the user for the current key.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofList<Interval> getFacetIntervalsList()
If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.v2.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.v2.Interval facet_intervals = 1;Interval getFacetIntervals(int index)
If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.v2.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.v2.Interval facet_intervals = 1;int getFacetIntervalsCount()
If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.v2.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.v2.Interval facet_intervals = 1;List<? extends IntervalOrBuilder> getFacetIntervalsOrBuilderList()
If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.v2.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.v2.Interval facet_intervals = 1;IntervalOrBuilder getFacetIntervalsOrBuilder(int index)
If you don't set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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.v2.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.v2.Interval facet_intervals = 1;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.v2.CatalogAttribute] is 25.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2.CatalogAttribute] is 25.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2.CatalogAttribute] is 25.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2.CatalogAttribute] is 25.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2.CatalogAttribute] is 25.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
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.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
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.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
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.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
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.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.
repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
boolean hasMergedFacet()
Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
CatalogAttribute.FacetConfig.MergedFacet getMergedFacet()
Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
CatalogAttribute.FacetConfig.MergedFacetOrBuilder getMergedFacetOrBuilder()
Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
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.v2.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
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.v2.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
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.v2.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
Copyright © 2025 Google LLC. All rights reserved.