Class AttributesConfig (2.39.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
TypeDescription
int

CATALOG_ATTRIBUTES_FIELD_NUMBER

public static final int CATALOG_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AttributesConfig getDefaultInstance()
Returns
TypeDescription
AttributesConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AttributesConfig.Builder newBuilder()
Returns
TypeDescription
AttributesConfig.Builder

newBuilder(AttributesConfig prototype)

public static AttributesConfig.Builder newBuilder(AttributesConfig prototype)
Parameter
NameDescription
prototypeAttributesConfig
Returns
TypeDescription
AttributesConfig.Builder

parseDelimitedFrom(InputStream input)

public static AttributesConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AttributesConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AttributesConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AttributesConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AttributesConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AttributesConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AttributesConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AttributesConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AttributesConfig> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for attributeConfigLevel.

getCatalogAttributes() (deprecated)

public Map<String,CatalogAttribute> getCatalogAttributes()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueCatalogAttribute
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
CatalogAttribute

getDefaultInstanceForType()

public AttributesConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AttributesConfig> getParserForType()
Returns
TypeDescription
Parser<AttributesConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AttributesConfig.Builder newBuilderForType()
Returns
TypeDescription
AttributesConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AttributesConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AttributesConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AttributesConfig.Builder toBuilder()
Returns
TypeDescription
AttributesConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException