REST Resource: projects.locations.entryGroups.tags

Resource: 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.

JSON representation 
{
  "name": string,
  "template": string,
  "templateDisplayName": string,
  "fields": {
    string: {
      object (TagField)
    },
    ...
  },

  // Union field scope can be only one of the following:
  "column": string
  // End of list of possible types for union field scope.
}
Fields
name

string

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.
template

string

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.
templateDisplayName

string

Output only. The display name of the tag template.
fields

map (key: string, value: object (TagField))

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.

Union field scope. The scope within the parent resource that this tag is attached to. If not provided, the tag is attached to the parent resource itself.

Deleting the scope from the parent resource deletes all tags attached to that scope.

These fields cannot be updated after creation. scope can be only one of the following:
column

string

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.

Methods

create

Creates a tag and assigns it to:

  • An Entry if the method name is projects.locations.entryGroups.entries.tags.create.

delete

 Deletes a tag.

list

 Lists tags assigned to an Entry.

patch

 Updates an existing tag.