- 1.59.0 (latest)
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
public static final class TagTemplateField.Builder extends GeneratedMessageV3.Builder<TagTemplateField.Builder> implements TagTemplateFieldOrBuilderThe 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.BuilderImplements
TagTemplateFieldOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
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. |
clearField(Descriptors.FieldDescriptor field)
public TagTemplateField.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.Builder |
|
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 |
|
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 |
|
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()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 |
|
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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplateField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| 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. |
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 |
|
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)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 |
StringThe 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 |
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. |
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 |
|
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 |
|