Class AttributesConfig.Builder (2.47.0)

public static final class AttributesConfig.Builder extends GeneratedMessageV3.Builder<AttributesConfig.Builder> implements AttributesConfigOrBuilder

Catalog level attribute config.

Protobuf type google.cloud.retail.v2.AttributesConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AttributesConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AttributesConfig.Builder
Overrides

build()

public AttributesConfig build()
Returns
Type Description
AttributesConfig

buildPartial()

public AttributesConfig buildPartial()
Returns
Type Description
AttributesConfig

clear()

public AttributesConfig.Builder clear()
Returns
Type Description
AttributesConfig.Builder
Overrides

clearAttributeConfigLevel()

public AttributesConfig.Builder clearAttributeConfigLevel()

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
AttributesConfig.Builder

This builder for chaining.

clearCatalogAttributes()

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

clearField(Descriptors.FieldDescriptor field)

public AttributesConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AttributesConfig.Builder
Overrides

clearName()

public AttributesConfig.Builder clearName()

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
AttributesConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AttributesConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AttributesConfig.Builder
Overrides

clone()

public AttributesConfig.Builder clone()
Returns
Type Description
AttributesConfig.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableCatalogAttributes() (deprecated)

public Map<String,CatalogAttribute> getMutableCatalogAttributes()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,CatalogAttribute>

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AttributesConfig other)

public AttributesConfig.Builder mergeFrom(AttributesConfig other)
Parameter
Name Description
other AttributesConfig
Returns
Type Description
AttributesConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AttributesConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributesConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AttributesConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AttributesConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AttributesConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AttributesConfig.Builder
Overrides

putAllCatalogAttributes(Map<String,CatalogAttribute> values)

public AttributesConfig.Builder putAllCatalogAttributes(Map<String,CatalogAttribute> values)

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
values Map<String,CatalogAttribute>
Returns
Type Description
AttributesConfig.Builder

putCatalogAttributes(String key, CatalogAttribute value)

public AttributesConfig.Builder putCatalogAttributes(String key, CatalogAttribute value)

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
value CatalogAttribute
Returns
Type Description
AttributesConfig.Builder

putCatalogAttributesBuilderIfAbsent(String key)

public CatalogAttribute.Builder putCatalogAttributesBuilderIfAbsent(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.Builder

removeCatalogAttributes(String key)

public AttributesConfig.Builder removeCatalogAttributes(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
AttributesConfig.Builder

setAttributeConfigLevel(AttributeConfigLevel value)

public AttributesConfig.Builder setAttributeConfigLevel(AttributeConfigLevel value)

Output only. The AttributeConfigLevel used for this catalog.

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

Parameter
Name Description
value AttributeConfigLevel

The attributeConfigLevel to set.

Returns
Type Description
AttributesConfig.Builder

This builder for chaining.

setAttributeConfigLevelValue(int value)

public AttributesConfig.Builder setAttributeConfigLevelValue(int value)

Output only. The AttributeConfigLevel used for this catalog.

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

Parameter
Name Description
value int

The enum numeric value on the wire for attributeConfigLevel to set.

Returns
Type Description
AttributesConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AttributesConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AttributesConfig.Builder
Overrides

setName(String value)

public AttributesConfig.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
AttributesConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AttributesConfig.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
AttributesConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AttributesConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AttributesConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AttributesConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AttributesConfig.Builder
Overrides