public final class CatalogAttribute extends GeneratedMessageV3 implements CatalogAttributeOrBuilder
Catalog level attribute config for an attribute. For example, if customers
want to enable/disable facet for a specific attribute.
Protobuf type google.cloud.retail.v2alpha.CatalogAttribute
Static Fields
DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
public static final int DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXACT_SEARCHABLE_OPTION_FIELD_NUMBER
public static final int EXACT_SEARCHABLE_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INDEXABLE_OPTION_FIELD_NUMBER
public static final int INDEXABLE_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IN_USE_FIELD_NUMBER
public static final int IN_USE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECOMMENDATIONS_FILTERING_OPTION_FIELD_NUMBER
public static final int RECOMMENDATIONS_FILTERING_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETRIEVABLE_OPTION_FIELD_NUMBER
public static final int RETRIEVABLE_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SEARCHABLE_OPTION_FIELD_NUMBER
public static final int SEARCHABLE_OPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static CatalogAttribute getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CatalogAttribute.Builder newBuilder()
newBuilder(CatalogAttribute prototype)
public static CatalogAttribute.Builder newBuilder(CatalogAttribute prototype)
public static CatalogAttribute parseDelimitedFrom(InputStream input)
public static CatalogAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CatalogAttribute parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CatalogAttribute parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(CodedInputStream input)
public static CatalogAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(InputStream input)
public static CatalogAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CatalogAttribute parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CatalogAttribute> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public CatalogAttribute getDefaultInstanceForType()
getDynamicFacetableOption()
public CatalogAttribute.DynamicFacetableOption getDynamicFacetableOption()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet. Could only be DYNAMIC_FACETABLE_DISABLED if
CatalogAttribute.indexable_option
is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
getDynamicFacetableOptionValue()
public int getDynamicFacetableOptionValue()
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
facet. Could only be DYNAMIC_FACETABLE_DISABLED if
CatalogAttribute.indexable_option
is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for dynamicFacetableOption.
|
getExactSearchableOption()
public CatalogAttribute.ExactSearchableOption getExactSearchableOption()
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
This property only applies to textual custom attributes and requires
indexable set to enabled to enable exact-searchable. If unset, the server
behavior defaults to
EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
getExactSearchableOptionValue()
public int getExactSearchableOptionValue()
If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
This property only applies to textual custom attributes and requires
indexable set to enabled to enable exact-searchable. If unset, the server
behavior defaults to
EXACT_SEARCHABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for exactSearchableOption.
|
getInUse()
public boolean getInUse()
Output only. Indicates whether this attribute has been used by any
products. True if at least one
Product is using this attribute in
Product.attributes.
Otherwise, this field is False.
CatalogAttribute can be
pre-loaded by using
CatalogService.AddCatalogAttribute,
CatalogService.ImportCatalogAttributes,
or
CatalogService.UpdateAttributesConfig
APIs. This field is False for pre-loaded
CatalogAttributes.
Only pre-loaded catalog
attributes that are neither
in use by products nor predefined can be deleted. Catalog
attributes that are
either in use by products or are predefined attributes cannot be deleted;
however, their configuration properties will reset to default values upon
removal request.
After catalog changes, it takes about 10 minutes for this field to update.
bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The inUse.
|
getIndexableOption()
public CatalogAttribute.IndexableOption getIndexableOption()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
are indexed so that it can be filtered, faceted, or boosted in
SearchService.Search.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
getIndexableOptionValue()
public int getIndexableOptionValue()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
are indexed so that it can be filtered, faceted, or boosted in
SearchService.Search.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for indexableOption.
|
getKey()
Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The key.
|
getKeyBytes()
public ByteString getKeyBytes()
Required. Attribute name.
For example: color, brands, attributes.custom_attribute, such as
attributes.xyz.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named
attributes.abc_xyz can be indexed, but an attribute named
attributes.abc-xyz cannot be indexed.
If the attribute key starts with attributes., then the attribute is a
custom attribute. Attributes such as brands, patterns, and title are
built-in and called system attributes.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for key.
|
getParserForType()
public Parser<CatalogAttribute> getParserForType()
Overrides
getRecommendationsFilteringOption()
public RecommendationsFilteringOption getRecommendationsFilteringOption()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
This option works for categorical features only,
does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
getRecommendationsFilteringOptionValue()
public int getRecommendationsFilteringOptionValue()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,
attribute values are filterable for recommendations.
This option works for categorical features only,
does not work for numerical features, inventory filtering.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption recommendations_filtering_option = 8;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for recommendationsFilteringOption.
|
getRetrievableOption()
public CatalogAttribute.RetrievableOption getRetrievableOption()
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results. If unset, the server behavior defaults to
RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
getRetrievableOptionValue()
public int getRetrievableOptionValue()
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
results. If unset, the server behavior defaults to
RETRIEVABLE_DISABLED.
.google.cloud.retail.v2alpha.CatalogAttribute.RetrievableOption retrievable_option = 12;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for retrievableOption.
|
getSearchableOption()
public CatalogAttribute.SearchableOption getSearchableOption()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values
will not be searchable by text queries in
SearchService.Search,
as there are no text values associated to numerical attributes.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
getSearchableOptionValue()
public int getSearchableOptionValue()
When
AttributesConfig.attribute_config_level
is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
are searchable by text queries in
SearchService.Search.
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values
will not be searchable by text queries in
SearchService.Search,
as there are no text values associated to numerical attributes.
Must be specified, otherwise throws INVALID_FORMAT error.
.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for searchableOption.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
public CatalogAttribute.AttributeType getType()
Output only. The type of this attribute. This is derived from the attribute
in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTypeValue()
public int getTypeValue()
Output only. The type of this attribute. This is derived from the attribute
in Product.attributes.
.google.cloud.retail.v2alpha.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CatalogAttribute.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CatalogAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CatalogAttribute.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
