Class AttributesConfig (2.45.0)

public final class AttributesConfig extends GeneratedMessageV3 implements AttributesConfigOrBuilder

Catalog level attribute config.

Protobuf type google.cloud.retail.v2.AttributesConfig

Static Fields

ATTRIBUTE_CONFIG_LEVEL_FIELD_NUMBER

public static final int ATTRIBUTE_CONFIG_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

CATALOG_ATTRIBUTES_FIELD_NUMBER

public static final int CATALOG_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AttributesConfig getDefaultInstance()
Returns
Type Description
AttributesConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AttributesConfig.Builder newBuilder()
Returns
Type Description
AttributesConfig.Builder

newBuilder(AttributesConfig prototype)

public static AttributesConfig.Builder newBuilder(AttributesConfig prototype)
Parameter
Name Description
prototype AttributesConfig
Returns
Type Description
AttributesConfig.Builder

parseDelimitedFrom(InputStream input)

public static AttributesConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AttributesConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AttributesConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AttributesConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AttributesConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AttributesConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AttributesConfig> parser()
Returns
Type Description
Parser<AttributesConfig>

Methods

containsCatalogAttributes(String key)

public boolean containsCatalogAttributes(String key)

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttributeConfigLevel()

public AttributeConfigLevel getAttributeConfigLevel()

Output only. The AttributeConfigLevel used for this catalog.

.google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AttributeConfigLevel

The attributeConfigLevel.

getAttributeConfigLevelValue()

public int getAttributeConfigLevelValue()

Output only. The AttributeConfigLevel used for this catalog.

.google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for attributeConfigLevel.

getCatalogAttributes() (deprecated)

public Map<String,CatalogAttribute> getCatalogAttributes()
Returns
Type Description
Map<String,CatalogAttribute>

getCatalogAttributesCount()

public int getCatalogAttributesCount()

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;

Returns
Type Description
int

getCatalogAttributesMap()

public Map<String,CatalogAttribute> getCatalogAttributesMap()

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;

Returns
Type Description
Map<String,CatalogAttribute>

getCatalogAttributesOrDefault(String key, CatalogAttribute defaultValue)

public CatalogAttribute getCatalogAttributesOrDefault(String key, CatalogAttribute defaultValue)

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;

Parameters
Name Description
key String
defaultValue CatalogAttribute
Returns
Type Description
CatalogAttribute

getCatalogAttributesOrThrow(String key)

public CatalogAttribute getCatalogAttributesOrThrow(String key)

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute.

The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz.

The maximum number of catalog attributes allowed in a request is 1000.

map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;

Parameter
Name Description
key String
Returns
Type Description
CatalogAttribute

getDefaultInstanceForType()

public AttributesConfig getDefaultInstanceForType()
Returns
Type Description
AttributesConfig

getName()

public String getName()

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AttributesConfig> getParserForType()
Returns
Type Description
Parser<AttributesConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AttributesConfig.Builder newBuilderForType()
Returns
Type Description
AttributesConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AttributesConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AttributesConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AttributesConfig.Builder toBuilder()
Returns
Type Description
AttributesConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException