REST Resource: projects.locations.entryGroups.tags

Resource: Tag

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within 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

The resource name of the tag in URL format. Example:

  • projects/{projectId}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id}

where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
template

string

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

  • projects/{projectId}/locations/{location}/tagTemplates/{tagTemplateId}

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. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. 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 will delete 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 users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

Methods

create

 Creates a tag on an Entry.

delete

 Deletes a tag.

list

 Lists tags assigned to an Entry.

patch

 Updates an existing tag.