Class AttributesConfig.Builder (2.14.0)

Version 2.14.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

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

Catalog level attribute config.

Protobuf type google.cloud.retail.v2.AttributesConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AttributesConfig.Builder

Implements

AttributesConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public AttributesConfig.Builder clone()

Returns

Type	Description
AttributesConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

public Map<String,CatalogAttribute> getCatalogAttributes()

Use #getCatalogAttributesMap() instead.

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMutableCatalogAttributes()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public AttributesConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
AttributesConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AttributesConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
AttributesConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final AttributesConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
AttributesConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)