- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class CatalogAttribute.FacetConfig.Builder extends GeneratedMessageV3.Builder<CatalogAttribute.FacetConfig.Builder> implements CatalogAttribute.FacetConfigOrBuilderPossible options for the facet that corresponds to the current attribute config.
Protobuf type google.cloud.retail.v2beta.CatalogAttribute.FacetConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CatalogAttribute.FacetConfig.BuilderImplements
CatalogAttribute.FacetConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllFacetIntervals(Iterable<? extends Interval> values)
public CatalogAttribute.FacetConfig.Builder addAllFacetIntervals(Iterable<? extends Interval> values)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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2beta.Interval> |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addAllIgnoredFacetValues(Iterable<? extends CatalogAttribute.FacetConfig.IgnoredFacetValues> values)
public CatalogAttribute.FacetConfig.Builder addAllIgnoredFacetValues(Iterable<? extends CatalogAttribute.FacetConfig.IgnoredFacetValues> values)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues> |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addAllMergedFacetValues(Iterable<? extends CatalogAttribute.FacetConfig.MergedFacetValue> values)
public CatalogAttribute.FacetConfig.Builder addAllMergedFacetValues(Iterable<? extends CatalogAttribute.FacetConfig.MergedFacetValue> values)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue> |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addFacetIntervals(Interval value)
public CatalogAttribute.FacetConfig.Builder addFacetIntervals(Interval value)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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addFacetIntervals(Interval.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addFacetIntervals(Interval.Builder builderForValue)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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addFacetIntervals(int index, Interval value)
public CatalogAttribute.FacetConfig.Builder addFacetIntervals(int index, Interval value)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.v2beta.Interval facet_intervals = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addFacetIntervals(int index, Interval.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addFacetIntervals(int index, Interval.Builder builderForValue)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.v2beta.Interval facet_intervals = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addFacetIntervalsBuilder()
public Interval.Builder addFacetIntervalsBuilder()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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
addFacetIntervalsBuilder(int index)
public Interval.Builder addFacetIntervalsBuilder(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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
addIgnoredFacetValues(CatalogAttribute.FacetConfig.IgnoredFacetValues value)
public CatalogAttribute.FacetConfig.Builder addIgnoredFacetValues(CatalogAttribute.FacetConfig.IgnoredFacetValues value)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.IgnoredFacetValues |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addIgnoredFacetValues(CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addIgnoredFacetValues(CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues value)
public CatalogAttribute.FacetConfig.Builder addIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues value)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CatalogAttribute.FacetConfig.IgnoredFacetValues |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addIgnoredFacetValuesBuilder()
public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addIgnoredFacetValuesBuilder()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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
|
addIgnoredFacetValuesBuilder(int index)
public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addIgnoredFacetValuesBuilder(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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
|
addMergedFacetValues(CatalogAttribute.FacetConfig.MergedFacetValue value)
public CatalogAttribute.FacetConfig.Builder addMergedFacetValues(CatalogAttribute.FacetConfig.MergedFacetValue value)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.MergedFacetValue |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addMergedFacetValues(CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addMergedFacetValues(CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue value)
public CatalogAttribute.FacetConfig.Builder addMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue value)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CatalogAttribute.FacetConfig.MergedFacetValue |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder addMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
addMergedFacetValuesBuilder()
public CatalogAttribute.FacetConfig.MergedFacetValue.Builder addMergedFacetValuesBuilder()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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
|
addMergedFacetValuesBuilder(int index)
public CatalogAttribute.FacetConfig.MergedFacetValue.Builder addMergedFacetValuesBuilder(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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.FacetConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
build()
public CatalogAttribute.FacetConfig build()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig |
|
buildPartial()
public CatalogAttribute.FacetConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig |
|
clear()
public CatalogAttribute.FacetConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearFacetIntervals()
public CatalogAttribute.FacetConfig.Builder clearFacetIntervals()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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CatalogAttribute.FacetConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearIgnoredFacetValues()
public CatalogAttribute.FacetConfig.Builder clearIgnoredFacetValues()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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearMergedFacet()
public CatalogAttribute.FacetConfig.Builder clearMergedFacet()Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearMergedFacetValues()
public CatalogAttribute.FacetConfig.Builder clearMergedFacetValues()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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CatalogAttribute.FacetConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clearRerankConfig()
public CatalogAttribute.FacetConfig.Builder clearRerankConfig()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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
clone()
public CatalogAttribute.FacetConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
getDefaultInstanceForType()
public CatalogAttribute.FacetConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFacetIntervals(int index)
public 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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval |
|
getFacetIntervalsBuilder(int index)
public Interval.Builder getFacetIntervalsBuilder(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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
getFacetIntervalsBuilderList()
public List<Interval.Builder> getFacetIntervalsBuilderList()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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getFacetIntervalsCount()
public 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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFacetIntervalsList()
public 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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
List<Interval> |
|
getFacetIntervalsOrBuilder(int index)
public 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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
IntervalOrBuilder |
|
getFacetIntervalsOrBuilderList()
public 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.v2beta.Interval facet_intervals = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.IntervalOrBuilder> |
|
getIgnoredFacetValues(int index)
public 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.IgnoredFacetValues |
|
getIgnoredFacetValuesBuilder(int index)
public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder getIgnoredFacetValuesBuilder(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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
|
getIgnoredFacetValuesBuilderList()
public List<CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder> getIgnoredFacetValuesBuilderList()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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getIgnoredFacetValuesCount()
public 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getIgnoredFacetValuesList()
public 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
List<IgnoredFacetValues> |
|
getIgnoredFacetValuesOrBuilder(int index)
public 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder |
|
getIgnoredFacetValuesOrBuilderList()
public 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder> |
|
getMergedFacet()
public CatalogAttribute.FacetConfig.MergedFacet getMergedFacet()Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacet |
The mergedFacet. |
getMergedFacetBuilder()
public CatalogAttribute.FacetConfig.MergedFacet.Builder getMergedFacetBuilder()Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacet.Builder |
|
getMergedFacetOrBuilder()
public CatalogAttribute.FacetConfig.MergedFacetOrBuilder getMergedFacetOrBuilder()Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetOrBuilder |
|
getMergedFacetValues(int index)
public 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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetValue |
|
getMergedFacetValuesBuilder(int index)
public CatalogAttribute.FacetConfig.MergedFacetValue.Builder getMergedFacetValuesBuilder(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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
|
getMergedFacetValuesBuilderList()
public List<CatalogAttribute.FacetConfig.MergedFacetValue.Builder> getMergedFacetValuesBuilderList()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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getMergedFacetValuesCount()
public 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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMergedFacetValuesList()
public 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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
List<MergedFacetValue> |
|
getMergedFacetValuesOrBuilder(int index)
public 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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder |
|
getMergedFacetValuesOrBuilderList()
public 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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder> |
|
getRerankConfig()
public 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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.RerankConfig |
The rerankConfig. |
getRerankConfigBuilder()
public CatalogAttribute.FacetConfig.RerankConfig.Builder getRerankConfigBuilder()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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.RerankConfig.Builder |
|
getRerankConfigOrBuilder()
public 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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.RerankConfigOrBuilder |
|
hasMergedFacet()
public boolean hasMergedFacet()Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mergedFacet field is set. |
hasRerankConfig()
public 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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rerankConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CatalogAttribute.FacetConfig other)
public CatalogAttribute.FacetConfig.Builder mergeFrom(CatalogAttribute.FacetConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
CatalogAttribute.FacetConfig |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CatalogAttribute.FacetConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CatalogAttribute.FacetConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
mergeMergedFacet(CatalogAttribute.FacetConfig.MergedFacet value)
public CatalogAttribute.FacetConfig.Builder mergeMergedFacet(CatalogAttribute.FacetConfig.MergedFacet value)Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.MergedFacet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
mergeRerankConfig(CatalogAttribute.FacetConfig.RerankConfig value)
public CatalogAttribute.FacetConfig.Builder mergeRerankConfig(CatalogAttribute.FacetConfig.RerankConfig value)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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.RerankConfig |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.FacetConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
removeFacetIntervals(int index)
public CatalogAttribute.FacetConfig.Builder removeFacetIntervals(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.v2beta.Interval facet_intervals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
removeIgnoredFacetValues(int index)
public CatalogAttribute.FacetConfig.Builder removeIgnoredFacetValues(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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
removeMergedFacetValues(int index)
public CatalogAttribute.FacetConfig.Builder removeMergedFacetValues(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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setFacetIntervals(int index, Interval value)
public CatalogAttribute.FacetConfig.Builder setFacetIntervals(int index, Interval value)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.v2beta.Interval facet_intervals = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setFacetIntervals(int index, Interval.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder setFacetIntervals(int index, Interval.Builder builderForValue)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.v2beta.Interval facet_intervals = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CatalogAttribute.FacetConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues value)
public CatalogAttribute.FacetConfig.Builder setIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues value)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CatalogAttribute.FacetConfig.IgnoredFacetValues |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder setIgnoredFacetValues(int index, CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setMergedFacet(CatalogAttribute.FacetConfig.MergedFacet value)
public CatalogAttribute.FacetConfig.Builder setMergedFacet(CatalogAttribute.FacetConfig.MergedFacet value)Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.MergedFacet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setMergedFacet(CatalogAttribute.FacetConfig.MergedFacet.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder setMergedFacet(CatalogAttribute.FacetConfig.MergedFacet.Builder builderForValue)Use this field only if you want to merge a facet key into another facet key.
.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CatalogAttribute.FacetConfig.MergedFacet.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue value)
public CatalogAttribute.FacetConfig.Builder setMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue value)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CatalogAttribute.FacetConfig.MergedFacetValue |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder setMergedFacetValues(int index, CatalogAttribute.FacetConfig.MergedFacetValue.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CatalogAttribute.FacetConfig.MergedFacetValue.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CatalogAttribute.FacetConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setRerankConfig(CatalogAttribute.FacetConfig.RerankConfig value)
public CatalogAttribute.FacetConfig.Builder setRerankConfig(CatalogAttribute.FacetConfig.RerankConfig value)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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
CatalogAttribute.FacetConfig.RerankConfig |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setRerankConfig(CatalogAttribute.FacetConfig.RerankConfig.Builder builderForValue)
public CatalogAttribute.FacetConfig.Builder setRerankConfig(CatalogAttribute.FacetConfig.RerankConfig.Builder builderForValue)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.v2beta.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CatalogAttribute.FacetConfig.RerankConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CatalogAttribute.FacetConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CatalogAttribute.FacetConfig.Builder |
|