public static final class CatalogAttribute.FacetConfig extends GeneratedMessageV3 implements CatalogAttribute.FacetConfigOrBuilder
Possible options for the facet that corresponds to the current attribute
config.
Protobuf type google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FACET_INTERVALS_FIELD_NUMBER
public static final int FACET_INTERVALS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IGNORED_FACET_VALUES_FIELD_NUMBER
public static final int IGNORED_FACET_VALUES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MERGED_FACET_FIELD_NUMBER
public static final int MERGED_FACET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MERGED_FACET_VALUES_FIELD_NUMBER
public static final int MERGED_FACET_VALUES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RERANK_CONFIG_FIELD_NUMBER
public static final int RERANK_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CatalogAttribute.FacetConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CatalogAttribute.FacetConfig.Builder newBuilder()
newBuilder(CatalogAttribute.FacetConfig prototype)
public static CatalogAttribute.FacetConfig.Builder newBuilder(CatalogAttribute.FacetConfig prototype)
public static CatalogAttribute.FacetConfig parseDelimitedFrom(InputStream input)
public static CatalogAttribute.FacetConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CatalogAttribute.FacetConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute.FacetConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CatalogAttribute.FacetConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute.FacetConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute.FacetConfig parseFrom(CodedInputStream input)
public static CatalogAttribute.FacetConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute.FacetConfig parseFrom(InputStream input)
public static CatalogAttribute.FacetConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CatalogAttribute.FacetConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute.FacetConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CatalogAttribute.FacetConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CatalogAttribute.FacetConfig getDefaultInstanceForType()
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.v2alpha.Interval facet_intervals = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.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.v2alpha.Interval facet_intervals = 1;
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.v2alpha.Interval facet_intervals = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.Interval facet_intervals = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2alpha.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.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.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.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
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.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.CatalogAttribute.FacetConfig.IgnoredFacetValues ignored_facet_values = 2;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2alpha.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.v2alpha.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
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.v2alpha.CatalogAttribute.FacetConfig.MergedFacet merged_facet = 4;
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.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.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.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
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.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Parameter |
| Name |
Description |
index |
int
|
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.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValue merged_facet_values = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig.MergedFacetValueOrBuilder> |
|
getParserForType()
public Parser<CatalogAttribute.FacetConfig> getParserForType()
Overrides
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.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
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.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasMergedFacet()
public 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 |
| 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.v2alpha.CatalogAttribute.FacetConfig.RerankConfig rerank_config = 5;
| Returns |
| Type |
Description |
boolean |
Whether the rerankConfig field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CatalogAttribute.FacetConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CatalogAttribute.FacetConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CatalogAttribute.FacetConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
