Data Catalog v1 API - Class TagTemplateField (2.2.0)

public sealed class TagTemplateField : IMessage<TagTemplateField>, IEquatable<TagTemplateField>, IDeepCloneable<TagTemplateField>, IBufferMessage, IMessage

Reference documentation and code samples for the Data Catalog v1 API class TagTemplateField.

The template for an individual field within a tag template.

Inheritance

Object > TagTemplateField

Implements

IMessage<TagTemplateField>, IEquatable<TagTemplateField>, IDeepCloneable<TagTemplateField>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagTemplateField()

public TagTemplateField()

TagTemplateField(TagTemplateField)

public TagTemplateField(TagTemplateField other)

Parameter
Name	Description
`other`	`TagTemplateField`

Properties

Description

public string Description { get; set; }

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

Property Value
Type	Description
`String`

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type	Description
`String`

IsRequired

public bool IsRequired { get; set; }

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

Property Value
Type	Description
`Boolean`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`String`

Order

public int Order { get; set; }

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.

Property Value
Type	Description
`Int32`

TagTemplateFieldName

public TagTemplateFieldName TagTemplateFieldName { get; set; }

TagTemplateFieldName-typed view over the Name resource name property.

Property Value
Type	Description
`TagTemplateFieldName`

Type

public FieldType Type { get; set; }

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

Property Value
Type	Description
`FieldType`