Interface TagTemplateFieldOrBuilder (1.9.0)

Version 1.9.0

• 1.47.0 (latest)
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public interface TagTemplateFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

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

string description = 4;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract 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 abstract 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 abstract 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 abstract boolean getIsRequired()

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

bool is_required = 3;

Returns

Type	Description
boolean	The isRequired.

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract 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()

public abstract 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

Type	Description
int	The order.

getType()

public abstract 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

Type	Description
FieldType	The type.

getTypeOrBuilder()

public abstract 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

Type	Description
FieldTypeOrBuilder

hasType()

public abstract 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

Type	Description
boolean	Whether the type field is set.