Interface TagTemplateFieldOrBuilder (1.59.0)

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.

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.

string display_name = 1;

Returns
Type Description
ByteString

The bytes for displayName.

getIsRequired()

public abstract boolean getIsRequired()

Whether this is a required field. Defaults to false.

bool is_required = 3;

Returns
Type Description
boolean

The isRequired.

getName()

public abstract String getName()

Output only. Identifier. The resource name of the tag template field in URL format. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}

    Note that this TagTemplateField may not actually be stored in the location in this name.

string name = 6 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Identifier. The resource name of the tag template field in URL format. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}

    Note that this TagTemplateField may not actually be stored in the location in this name.

string name = 6 [(.google.api.field_behavior) = IDENTIFIER, (.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. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not 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.v1beta1.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.v1beta1.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.v1beta1.FieldType type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the type field is set.