com.google.cloud.datacatalog.v1

Class TagTemplateField

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datacatalog.v1.TagTemplateField

All Implemented Interfaces:

TagTemplateFieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class TagTemplateField
extends com.google.protobuf.GeneratedMessageV3
implements TagTemplateFieldOrBuilder

 The template for an individual field within a tag template.
 

Protobuf type google.cloud.datacatalog.v1.TagTemplateField

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagTemplateField.Builder The template for an individual field within a tag template.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	IS_REQUIRED_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	ORDER_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TagTemplateField	getDefaultInstance()
TagTemplateField	getDefaultInstanceForType()
String	getDescription() The description for this field.
com.google.protobuf.ByteString	getDescriptionBytes() The description for this field.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The display name for this field.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name for this field.
boolean	getIsRequired() If true, this field is required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
int	getOrder() The order of this field with respect to other fields in this tag template.
com.google.protobuf.Parser<TagTemplateField>	getParserForType()
int	getSerializedSize()
FieldType	getType() Required.
FieldTypeOrBuilder	getTypeOrBuilder() Required.
int	hashCode()
boolean	hasType() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TagTemplateField.Builder	newBuilder()
static TagTemplateField.Builder	newBuilder(TagTemplateField prototype)
TagTemplateField.Builder	newBuilderForType()
protected TagTemplateField.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TagTemplateField	parseDelimitedFrom(InputStream input)
static TagTemplateField	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TagTemplateField	parseFrom(byte[] data)
static TagTemplateField	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TagTemplateField	parseFrom(ByteBuffer data)
static TagTemplateField	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TagTemplateField	parseFrom(com.google.protobuf.ByteString data)
static TagTemplateField	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TagTemplateField	parseFrom(com.google.protobuf.CodedInputStream input)
static TagTemplateField	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TagTemplateField	parseFrom(InputStream input)
static TagTemplateField	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TagTemplateField>	parser()
TagTemplateField.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

IS_REQUIRED_FIELD_NUMBER

public static final int IS_REQUIRED_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

getName in interface TagTemplateFieldOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface TagTemplateFieldOrBuilder

Returns:

The bytes for name.

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;

Specified by:

getDisplayName in interface TagTemplateFieldOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.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;

Specified by:

getDisplayNameBytes in interface TagTemplateFieldOrBuilder

Returns:

The bytes for displayName.

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];

Specified by:

hasType in interface TagTemplateFieldOrBuilder

Returns:

Whether the type field is set.

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];

Specified by:

getType in interface TagTemplateFieldOrBuilder

Returns:

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];

Specified by:

getTypeOrBuilder in interface TagTemplateFieldOrBuilder

getIsRequired

public boolean getIsRequired()

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

bool is_required = 3;

Specified by:

getIsRequired in interface TagTemplateFieldOrBuilder

Returns:

The isRequired.

getDescription

public String getDescription()

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

string description = 4;

Specified by:

getDescription in interface TagTemplateFieldOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 4;

Specified by:

getDescriptionBytes in interface TagTemplateFieldOrBuilder

Returns:

The bytes for description.

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;

Specified by:

getOrder in interface TagTemplateFieldOrBuilder

Returns:

The order.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TagTemplateField parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TagTemplateField parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static TagTemplateField parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static TagTemplateField parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static TagTemplateField parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static TagTemplateField parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static TagTemplateField parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public TagTemplateField.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TagTemplateField.Builder newBuilder()

newBuilder

public static TagTemplateField.Builder newBuilder(TagTemplateField prototype)

toBuilder

public TagTemplateField.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TagTemplateField.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TagTemplateField getDefaultInstance()

parser

public static com.google.protobuf.Parser<TagTemplateField> parser()

getParserForType

public com.google.protobuf.Parser<TagTemplateField> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TagTemplateField getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder