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
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IS_REQUIRED_FIELD_NUMBER
public static final int IS_REQUIRED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static TagTemplateField getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TagTemplateField.Builder newBuilder()
newBuilder(TagTemplateField prototype)
public static TagTemplateField.Builder newBuilder(TagTemplateField prototype)
public static TagTemplateField parseDelimitedFrom(InputStream input)
public static TagTemplateField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TagTemplateField parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TagTemplateField parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(CodedInputStream input)
public static TagTemplateField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(InputStream input)
public static TagTemplateField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TagTemplateField parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TagTemplateField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TagTemplateField> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public TagTemplateField getDefaultInstanceForType()
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.
|
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()
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()
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.
|
getParserForType()
public Parser<TagTemplateField> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
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()
Overrides
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TagTemplateField.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TagTemplateField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public TagTemplateField.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
