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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TagTemplateField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public TagTemplateField build()
Returns
buildPartial()
public TagTemplateField buildPartial()
Returns
clear()
public TagTemplateField.Builder clear()
Returns
Overrides
clearDescription()
public TagTemplateField.Builder clearDescription()
The description for this field. Defaults to an empty string.
string description = 4;
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;
clearField(Descriptors.FieldDescriptor field)
public TagTemplateField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearIsRequired()
public TagTemplateField.Builder clearIsRequired()
If true, this field is required. Defaults to false.
bool is_required = 3;
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public TagTemplateField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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;
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];
clone()
public TagTemplateField.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public TagTemplateField getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
The description for this field. Defaults to an empty string.
string description = 4;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
The description for this field. Defaults to an empty string.
string description = 4;
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| 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;
| Type | Description |
| ByteString | The bytes for displayName.
|
getIsRequired()
public boolean getIsRequired()
If true, this field is required. Defaults to false.
bool is_required = 3;
| Type | Description |
| boolean | The isRequired.
|
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];
| 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];
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;
| 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];
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];
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];
hasType()
Required. The type of value this tag field can contain.
.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the type field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(TagTemplateField other)
public TagTemplateField.Builder mergeFrom(TagTemplateField other)
Parameter
Returns
public TagTemplateField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public TagTemplateField.Builder mergeFrom(Message other)
Parameter
Returns
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];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplateField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setDescription(String value)
public TagTemplateField.Builder setDescription(String value)
The description for this field. Defaults to an empty string.
string description = 4;
| Name | Description |
| value | String
The description to set.
|
Returns
setDescriptionBytes(ByteString value)
public TagTemplateField.Builder setDescriptionBytes(ByteString value)
The description for this field. Defaults to an empty string.
string description = 4;
| Name | Description |
| value | ByteString
The bytes for description to set.
|
Returns
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;
| Name | Description |
| value | String
The displayName to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for displayName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public TagTemplateField.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setIsRequired(boolean value)
public TagTemplateField.Builder setIsRequired(boolean value)
If true, this field is required. Defaults to false.
bool is_required = 3;
| Name | Description |
| value | boolean
The isRequired to set.
|
Returns
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];
| Name | Description |
| value | String
The name to set.
|
Returns
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];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
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;
| Name | Description |
| value | int
The order to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TagTemplateField.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
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];
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];
setUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplateField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
