Interface CatalogAttribute.FacetConfigOrBuilder (2.50.0) 

public static interface CatalogAttribute.FacetConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFacetIntervals(int index)

public abstract Interval getFacetIntervals(int index)

If you don't set the facet 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 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;

Parameter
Name Description
index int
Returns
Type Description
Interval

getFacetIntervalsCount()

public abstract int getFacetIntervalsCount()

If you don't set the facet 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 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;

Returns
Type Description
int

getFacetIntervalsList()

public abstract List<Interval> getFacetIntervalsList()

If you don't set the facet 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 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;

Returns
Type Description
List<Interval>

getFacetIntervalsOrBuilder(int index)

public abstract IntervalOrBuilder getFacetIntervalsOrBuilder(int index)

If you don't set the facet 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 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;

Parameter
Name Description
index int
Returns
Type Description
IntervalOrBuilder

getFacetIntervalsOrBuilderList()

public abstract List<? extends IntervalOrBuilder> getFacetIntervalsOrBuilderList()

If you don't set the facet 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 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;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.IntervalOrBuilder>

getIgnoredFacetValues(int index)

public abstract 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 is 25.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

Parameter
Name Description
index int
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues

getIgnoredFacetValuesCount()

public abstract 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 is 25.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

Returns
Type Description
int

getIgnoredFacetValuesList()

public abstract 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 is 25.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

Returns
Type Description
List<IgnoredFacetValues>

getIgnoredFacetValuesOrBuilder(int index)

public abstract 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 is 25.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

Parameter
Name Description
index int
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder

getIgnoredFacetValuesOrBuilderList()

public abstract 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 is 25.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder>

getMergedFacet()

public abstract 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;

Returns
Type Description
CatalogAttribute.FacetConfig.MergedFacet

The mergedFacet.

getMergedFacetOrBuilder()

public abstract 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;

Returns
Type Description
CatalogAttribute.FacetConfig.MergedFacetOrBuilder

getMergedFacetValues(int index)

public abstract 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 is 100. This feature is available only for textual custom attributes.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

Parameter
Name Description
index int
Returns
Type Description
CatalogAttribute.FacetConfig.MergedFacetValue

getMergedFacetValuesCount()

public abstract 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 is 100. This feature is available only for textual custom attributes.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

Returns
Type Description
int

getMergedFacetValuesList()

public abstract 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 is 100. This feature is available only for textual custom attributes.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

Returns
Type Description
List<MergedFacetValue>

getMergedFacetValuesOrBuilder(int index)

public abstract 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 is 100. This feature is available only for textual custom attributes.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

Parameter
Name Description
index int
Returns
Type Description
CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder

getMergedFacetValuesOrBuilderList()

public abstract 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 is 100. This feature is available only for textual custom attributes.

repeated .google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder>

getRerankConfig()

public abstract 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;

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfig

The rerankConfig.

getRerankConfigOrBuilder()

public abstract 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;

Returns
Type Description
CatalogAttribute.FacetConfig.RerankConfigOrBuilder

hasMergedFacet()

public abstract 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;

Returns
Type Description
boolean

Whether the mergedFacet field is set.

hasRerankConfig()

public abstract 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;

Returns
Type Description
boolean

Whether the rerankConfig field is set.