Class TagTemplateField.Builder

public static final class TagTemplateField.Builder extends GeneratedMessageV3.Builder<TagTemplateField.Builder> implements TagTemplateFieldOrBuilder

The template for an individual field within a tag template.

Protobuf type google.cloud.datacatalog.v1.TagTemplateField

Inheritance

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

Implements

TagTemplateFieldOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TagTemplateField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

build()

public TagTemplateField build()

Returns

Type	Description
TagTemplateField

buildPartial()

public TagTemplateField buildPartial()

Returns

Type	Description
TagTemplateField

clear()

public TagTemplateField.Builder clear()

Returns

Type	Description
TagTemplateField.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescription()

public TagTemplateField.Builder clearDescription()

The description for this field. Defaults to an empty string.

string description = 4;

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

clearDisplayName()

public TagTemplateField.Builder clearDisplayName()

The display name for this field. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 1;

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TagTemplateField.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

clearIsRequired()

public TagTemplateField.Builder clearIsRequired()

If true, this field is required. Defaults to false.

bool is_required = 3;

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

clearName()

public TagTemplateField.Builder clearName()

Output only. The resource name of the tag template field in URL format. Example:
 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
 Note: The tag template field itself might not be stored in the location
 specified in its name.
 The name must contain only letters (a-z, A-Z), numbers (0-9),
 or underscores (_), and must start with a letter or underscore.
 The maximum length is 64 characters.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TagTemplateField.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

clearOrder()

public TagTemplateField.Builder clearOrder()

The order of this field with respect to other fields in this tag
 template.
 For example, a higher value can indicate a more important field.
 The value can be negative. Multiple fields can have the same order and
 field orders within a tag don't have to be sequential.

int32 order = 5;

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

clearType()

public TagTemplateField.Builder clearType()

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TagTemplateField.Builder

clone()

public TagTemplateField.Builder clone()

Returns

Type	Description
TagTemplateField.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TagTemplateField getDefaultInstanceForType()

Returns

Type	Description
TagTemplateField

getDescription()

public String getDescription()

The description for this field. Defaults to an empty string.

string description = 4;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description for this field. Defaults to an empty string.

string description = 4;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

The display name for this field. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 1;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name for this field. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 1;

Returns

Type	Description
ByteString	The bytes for displayName.

getIsRequired()

public boolean getIsRequired()

If true, this field is required. Defaults to false.

bool is_required = 3;

Returns

Type	Description
boolean	The isRequired.

getName()

public String getName()

Output only. The resource name of the tag template field in URL format. Example:
 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
 Note: The tag template field itself might not be stored in the location
 specified in its name.
 The name must contain only letters (a-z, A-Z), numbers (0-9),
 or underscores (_), and must start with a letter or underscore.
 The maximum length is 64 characters.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the tag template field in URL format. Example:
 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
 Note: The tag template field itself might not be stored in the location
 specified in its name.
 The name must contain only letters (a-z, A-Z), numbers (0-9),
 or underscores (_), and must start with a letter or underscore.
 The maximum length is 64 characters.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for name.

getOrder()

public int getOrder()

The order of this field with respect to other fields in this tag
 template.
 For example, a higher value can indicate a more important field.
 The value can be negative. Multiple fields can have the same order and
 field orders within a tag don't have to be sequential.

int32 order = 5;

Returns

Type	Description
int	The order.

getType()

public FieldType getType()

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
FieldType	The type.

getTypeBuilder()

public FieldType.Builder getTypeBuilder()

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
FieldType.Builder

getTypeOrBuilder()

public FieldTypeOrBuilder getTypeOrBuilder()

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
FieldTypeOrBuilder

hasType()

public boolean hasType()

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the type field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TagTemplateField other)

public TagTemplateField.Builder mergeFrom(TagTemplateField other)

Parameter

Name	Description
other	`TagTemplateField`

Returns

Type	Description
TagTemplateField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TagTemplateField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TagTemplateField.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

mergeType(FieldType value)

public TagTemplateField.Builder mergeType(FieldType value)

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`FieldType`

Returns

Type	Description
TagTemplateField.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplateField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

setDescription(String value)

public TagTemplateField.Builder setDescription(String value)

The description for this field. Defaults to an empty string.

string description = 4;

Parameter

Name	Description
value	`String` The description to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public TagTemplateField.Builder setDescriptionBytes(ByteString value)

The description for this field. Defaults to an empty string.

string description = 4;

Parameter

Name	Description
value	`ByteString` The bytes for description to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setDisplayName(String value)

public TagTemplateField.Builder setDisplayName(String value)

The display name for this field. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 1;

Parameter

Name	Description
value	`String` The displayName to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public TagTemplateField.Builder setDisplayNameBytes(ByteString value)

The display name for this field. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 1;

Parameter

Name	Description
value	`ByteString` The bytes for displayName to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TagTemplateField.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

setIsRequired(boolean value)

public TagTemplateField.Builder setIsRequired(boolean value)

If true, this field is required. Defaults to false.

bool is_required = 3;

Parameter

Name	Description
value	`boolean` The isRequired to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setName(String value)

public TagTemplateField.Builder setName(String value)

Output only. The resource name of the tag template field in URL format. Example:
 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
 Note: The tag template field itself might not be stored in the location
 specified in its name.
 The name must contain only letters (a-z, A-Z), numbers (0-9),
 or underscores (_), and must start with a letter or underscore.
 The maximum length is 64 characters.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setNameBytes(ByteString value)

public TagTemplateField.Builder setNameBytes(ByteString value)

Output only. The resource name of the tag template field in URL format. Example:
 `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}`
 Note: The tag template field itself might not be stored in the location
 specified in its name.
 The name must contain only letters (a-z, A-Z), numbers (0-9),
 or underscores (_), and must start with a letter or underscore.
 The maximum length is 64 characters.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

setOrder(int value)

public TagTemplateField.Builder setOrder(int value)

The order of this field with respect to other fields in this tag
 template.
 For example, a higher value can indicate a more important field.
 The value can be negative. Multiple fields can have the same order and
 field orders within a tag don't have to be sequential.

int32 order = 5;

Parameter

Name	Description
value	`int` The order to set.

Returns

Type	Description
TagTemplateField.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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

setType(FieldType value)

public TagTemplateField.Builder setType(FieldType value)

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`FieldType`

Returns

Type	Description
TagTemplateField.Builder

setType(FieldType.Builder builderForValue)

public TagTemplateField.Builder setType(FieldType.Builder builderForValue)

Required. The type of value this tag field can contain.

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	`FieldType.Builder`

Returns

Type	Description
TagTemplateField.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplateField.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
TagTemplateField.Builder

Overrides

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