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.v2.CatalogAttribute
Static Fields
DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
public static final int DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
Field Value
INDEXABLE_OPTION_FIELD_NUMBER
public static final int INDEXABLE_OPTION_FIELD_NUMBER
Field Value
IN_USE_FIELD_NUMBER
public static final int IN_USE_FIELD_NUMBER
Field Value
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER
Field Value
SEARCHABLE_OPTION_FIELD_NUMBER
public static final int SEARCHABLE_OPTION_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CatalogAttribute getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CatalogAttribute.Builder newBuilder()
Returns
newBuilder(CatalogAttribute prototype)
public static CatalogAttribute.Builder newBuilder(CatalogAttribute prototype)
Parameter
Returns
public static CatalogAttribute parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CatalogAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CatalogAttribute parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CatalogAttribute parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CatalogAttribute parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CatalogAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CatalogAttribute parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CatalogAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CatalogAttribute parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CatalogAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CatalogAttribute> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public CatalogAttribute getDefaultInstanceForType()
Returns
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.
.google.cloud.retail.v2.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.
.google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
| Type |
Description |
| int |
The enum numeric value on the wire for dynamicFacetableOption.
|
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
CatalogAttributes that are
neither in use by products nor predefined can be deleted.
CatalogAttributes that are
either in use by products or are predefined 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];
| 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.
.google.cloud.retail.v2.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.
.google.cloud.retail.v2.CatalogAttribute.IndexableOption indexable_option = 5;
| 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.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| 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.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<CatalogAttribute> getParserForType()
Returns
Overrides
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.
.google.cloud.retail.v2.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.
.google.cloud.retail.v2.CatalogAttribute.SearchableOption searchable_option = 7;
| Type |
Description |
| int |
The enum numeric value on the wire for searchableOption.
|
getSerializedSize()
public int getSerializedSize()
Returns
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.v2.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.v2.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| int |
The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CatalogAttribute.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CatalogAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CatalogAttribute.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
