public static final class TagTemplateField.Builder extends GeneratedMessage.Builder<TagTemplateField.Builder> implements TagTemplateFieldOrBuilderThe template for an individual field within a tag template.
Protobuf type google.cloud.datacatalog.v1.TagTemplateField
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > TagTemplateField.BuilderImplements
TagTemplateFieldOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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. |
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()Identifier. 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) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
This builder for chaining. |
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 |
|
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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()Identifier. 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) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Identifier. 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) = IDENTIFIER];
| 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TagTemplateField.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
This builder for chaining. |
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 |
booleanThe isRequired to set. |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
This builder for chaining. |
setName(String value)
public TagTemplateField.Builder setName(String value)Identifier. 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) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public TagTemplateField.Builder setNameBytes(ByteString value)Identifier. 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) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
intThe order to set. |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
This builder for chaining. |
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 |
|