Data Catalog v1 API - Class TagTemplate (2.16.0) 

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

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

A tag template defines a tag that can have one or more typed fields.

The template is used to create tags that are attached to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.

Inheritance

object > TagTemplate

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagTemplate()

public TagTemplate()

TagTemplate(TagTemplate)

public TagTemplate(TagTemplate other)
Parameter
Name Description
other TagTemplate

Properties

DataplexTransferStatus

public TagTemplate.Types.DataplexTransferStatus DataplexTransferStatus { get; set; }

Optional. Transfer status of the TagTemplate

Property Value
Type Description
TagTemplateTypesDataplexTransferStatus

DisplayName

public string DisplayName { get; set; }

Display name for this template. 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

Fields

public MapField<string, TagTemplateField> Fields { get; }

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.

The keys to this map are tag template field IDs. The IDs have the following limitations:

  • Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
  • Must be at least 1 character and at most 64 characters long.
  • Must start with a letter or underscore.
Property Value
Type Description
MapFieldstringTagTemplateField

IsPubliclyReadable

public bool IsPubliclyReadable { get; set; }

Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags] API response.

Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.

Property Value
Type Description
bool

Name

public string Name { get; set; }

Identifier. The resource name of the tag template in URL format.

Note: The tag template itself and its child resources might not be stored in the location specified in its name.

Property Value
Type Description
string

TagTemplateName

public TagTemplateName TagTemplateName { get; set; }

TagTemplateName-typed view over the Name resource name property.

Property Value
Type Description
TagTemplateName