Class TagTemplateField (1.9.3)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

IS_REQUIRED_FIELD_NUMBER

public static final int IS_REQUIRED_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TagTemplateField getDefaultInstance()
Returns
TypeDescription
TagTemplateField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TagTemplateField.Builder newBuilder()
Returns
TypeDescription
TagTemplateField.Builder

newBuilder(TagTemplateField prototype)

public static TagTemplateField.Builder newBuilder(TagTemplateField prototype)
Parameter
NameDescription
prototypeTagTemplateField
Returns
TypeDescription
TagTemplateField.Builder

parseDelimitedFrom(InputStream input)

public static TagTemplateField parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TagTemplateField parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TagTemplateField parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TagTemplateField parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TagTemplateField parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TagTemplateField parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TagTemplateField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagTemplateField
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TagTemplateField> parser()
Returns
TypeDescription
Parser<TagTemplateField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TagTemplateField getDefaultInstanceForType()
Returns
TypeDescription
TagTemplateField

getDescription()

public String getDescription()

The description for this field. Defaults to an empty string.

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description for this field. Defaults to an empty string.

string description = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getIsRequired()

public boolean getIsRequired()

If true, this field is required. Defaults to false.

bool is_required = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The order.

getParserForType()

public Parser<TagTemplateField> getParserForType()
Returns
TypeDescription
Parser<TagTemplateField>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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];

Returns
TypeDescription
FieldType

The type.

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
TypeDescription
FieldTypeOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the type field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TagTemplateField.Builder newBuilderForType()
Returns
TypeDescription
TagTemplateField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TagTemplateField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TagTemplateField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TagTemplateField.Builder toBuilder()
Returns
TypeDescription
TagTemplateField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException