public final class TagTemplateField extends GeneratedMessageV3 implements TagTemplateFieldOrBuilder
The template for an individual field within a tag template.
Protobuf type google.cloud.datacatalog.v1.TagTemplateField
Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
IS_REQUIRED_FIELD_NUMBER
public static final int IS_REQUIRED_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static TagTemplateField getDefaultInstance()
Returns
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
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.
|
getParserForType()
public Parser<TagTemplateField> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static TagTemplateField.Builder newBuilder()
Returns
newBuilder(TagTemplateField prototype)
public static TagTemplateField.Builder newBuilder(TagTemplateField prototype)
Parameter
Returns
newBuilderForType()
public TagTemplateField.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TagTemplateField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static TagTemplateField parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TagTemplateField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TagTemplateField parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TagTemplateField parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TagTemplateField parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TagTemplateField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TagTemplateField parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TagTemplateField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TagTemplateField parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TagTemplateField> parser()
Returns
toBuilder()
public TagTemplateField.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
