com.google.cloud.datacatalog.v1

Interface TagTemplateFieldOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TagTemplateField, TagTemplateField.Builder

public interface TagTemplateFieldOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDescription() The description for this field.
com.google.protobuf.ByteString	getDescriptionBytes() The description for this field.
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.
FieldType	getType() Required.
FieldTypeOrBuilder	getTypeOrBuilder() Required.
boolean	hasType() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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;

Returns:

The bytes for displayName.

hasType

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:

Whether the type field is set.

getType

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:

The type.

getTypeOrBuilder

FieldTypeOrBuilder getTypeOrBuilder()

 Required. The type of value this tag field can contain.
 

.google.cloud.datacatalog.v1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

getIsRequired

boolean getIsRequired()

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

bool is_required = 3;

Returns:

The isRequired.

getDescription

String getDescription()

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

string description = 4;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 4;

Returns:

The bytes for description.

getOrder

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:

The order.