Data Catalog v1 API - Class Tag (2.14.0) 

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

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

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

Inheritance

object > Tag

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

Tag()

public Tag()

Tag(Tag)

public Tag(Tag other)
Parameter
Name Description
other Tag

Properties

Column

public string Column { get; set; }

Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

Property Value
Type Description
string

DataplexTransferStatus

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

Output only. Denotes the transfer status of the Tag Template.

Property Value
Type Description
TagTemplateTypesDataplexTransferStatus

Fields

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

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

Property Value
Type Description
MapFieldstringTagField

HasColumn

public bool HasColumn { get; }

Gets whether the "column" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier.

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

Property Value
Type Description
string

ScopeCase

public Tag.ScopeOneofCase ScopeCase { get; }
Property Value
Type Description
TagScopeOneofCase

TagName

public TagName TagName { get; set; }

TagName-typed view over the Name resource name property.

Property Value
Type Description
TagName

Template

public string Template { get; set; }

Required. The resource name of the tag template this tag uses. Example:

projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

This field cannot be modified after creation.

Property Value
Type Description
string

TemplateDisplayName

public string TemplateDisplayName { get; set; }

Output only. The display name of the tag template.

Property Value
Type Description
string