Class TagTemplateField.Builder (1.8.4)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TagTemplateField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TagTemplateField.Builder
Overrides

build()

public TagTemplateField build()
Returns
TypeDescription
TagTemplateField

buildPartial()

public TagTemplateField buildPartial()
Returns
TypeDescription
TagTemplateField

clear()

public TagTemplateField.Builder clear()
Returns
TypeDescription
TagTemplateField.Builder
Overrides

clearDescription()

public TagTemplateField.Builder clearDescription()

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

string description = 4;

Returns
TypeDescription
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
TypeDescription
TagTemplateField.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TagTemplateField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TagTemplateField.Builder
Overrides

clearIsRequired()

public TagTemplateField.Builder clearIsRequired()

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

bool is_required = 3;

Returns
TypeDescription
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
TypeDescription
TagTemplateField.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TagTemplateField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TagTemplateField.Builder
Overrides

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
TypeDescription
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
TypeDescription
TagTemplateField.Builder

clone()

public TagTemplateField.Builder clone()
Returns
TypeDescription
TagTemplateField.Builder
Overrides

getDefaultInstanceForType()

public TagTemplateField getDefaultInstanceForType()
Returns
TypeDescription
TagTemplateField

getDescription()

public String getDescription()

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

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 4;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getIsRequired()

public boolean getIsRequired()

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

bool is_required = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the type field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TagTemplateField other)

public TagTemplateField.Builder mergeFrom(TagTemplateField other)
Parameter
NameDescription
otherTagTemplateField
Returns
TypeDescription
TagTemplateField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TagTemplateField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TagTemplateField.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TagTemplateField.Builder
Overrides

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
NameDescription
valueFieldType
Returns
TypeDescription
TagTemplateField.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplateField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TagTemplateField.Builder
Overrides

setDescription(String value)

public TagTemplateField.Builder setDescription(String value)

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

string description = 4;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
TagTemplateField.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TagTemplateField.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TagTemplateField.Builder
Overrides

setIsRequired(boolean value)

public TagTemplateField.Builder setIsRequired(boolean value)

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

bool is_required = 3;

Parameter
NameDescription
valueboolean

The isRequired to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueint

The order to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TagTemplateField.Builder
Overrides

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
NameDescription
valueFieldType
Returns
TypeDescription
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
NameDescription
builderForValueFieldType.Builder
Returns
TypeDescription
TagTemplateField.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplateField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TagTemplateField.Builder
Overrides