Class CatalogAttribute (2.54.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CatalogAttribute

Implements

CatalogAttributeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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`

FACET_CONFIG_FIELD_NUMBER

public static final int FACET_CONFIG_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()

Returns
Type	Description
`CatalogAttribute`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CatalogAttribute.Builder newBuilder()

Returns
Type	Description
`CatalogAttribute.Builder`

newBuilder(CatalogAttribute prototype)

public static CatalogAttribute.Builder newBuilder(CatalogAttribute prototype)

Parameter
Name	Description
`prototype`	`CatalogAttribute`

Returns
Type	Description
`CatalogAttribute.Builder`

parseDelimitedFrom(InputStream input)

public static CatalogAttribute parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CatalogAttribute parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CatalogAttribute parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CatalogAttribute parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CatalogAttribute parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CatalogAttribute parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CatalogAttribute`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CatalogAttribute> parser()

Returns
Type	Description
`Parser<CatalogAttribute>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public CatalogAttribute getDefaultInstanceForType()

Returns
Type	Description
`CatalogAttribute`

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;

Returns
Type	Description
`CatalogAttribute.DynamicFacetableOption`	The dynamicFacetableOption.

getDynamicFacetableOptionValue()

public int getDynamicFacetableOptionValue()

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;

Returns
Type	Description
`CatalogAttribute.ExactSearchableOption`	The exactSearchableOption.

getExactSearchableOptionValue()

public int getExactSearchableOptionValue()

.google.cloud.retail.v2alpha.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;

Returns
Type	Description
`int`	The enum numeric value on the wire for exactSearchableOption.

getFacetConfig()

public CatalogAttribute.FacetConfig getFacetConfig()

Contains facet options.

.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
`CatalogAttribute.FacetConfig`	The facetConfig.

getFacetConfigOrBuilder()

public CatalogAttribute.FacetConfigOrBuilder getFacetConfigOrBuilder()

Contains facet options.

.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
`CatalogAttribute.FacetConfigOrBuilder`

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 when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2alpha.CatalogAttribute.IndexableOption indexable_option = 5;

Returns
Type	Description
`CatalogAttribute.IndexableOption`	The indexableOption.

getIndexableOptionValue()

public int getIndexableOptionValue()

Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, 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()

public String 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()

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()

Returns
Type	Description
`Parser<CatalogAttribute>`

Overrides

GeneratedMessageV3.getParserForType()

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;

Returns
Type	Description
`RecommendationsFilteringOption`	The recommendationsFilteringOption.

getRecommendationsFilteringOptionValue()

public int getRecommendationsFilteringOptionValue()

.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;

Returns
Type	Description
`CatalogAttribute.RetrievableOption`	The retrievableOption.

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, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2alpha.CatalogAttribute.SearchableOption searchable_option = 7;

Returns
Type	Description
`CatalogAttribute.SearchableOption`	The searchableOption.

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, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, 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

GeneratedMessageV3.getSerializedSize()

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];

Returns
Type	Description
`CatalogAttribute.AttributeType`	The type.

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.

hasFacetConfig()

public boolean hasFacetConfig()

Contains facet options.

.google.cloud.retail.v2alpha.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
`boolean`	Whether the facetConfig field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CatalogAttribute.Builder newBuilderForType()

Returns
Type	Description
`CatalogAttribute.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CatalogAttribute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CatalogAttribute.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CatalogAttribute.Builder toBuilder()

Returns
Type	Description
`CatalogAttribute.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`