REST Resource: projects.locations.entryGroups.entries.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)
    },
    ...
  },
  "column": string
}
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.

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

TagField

Contains the value and supporting information for a field within a Tag.

JSON representation
{
  "displayName": string,
  "order": integer,

  // Union field kind can be only one of the following:
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "timestampValue": string,
  "enumValue": {
    object (EnumValue)
  }
  // End of list of possible types for union field kind.
}
Fields
displayName

string

Output only. The display name of this field.

order

integer

Output only. The order of this field with respect to other fields in this tag. It can be set in Tag. 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 do not have to be sequential.

Union field kind. Required. The value of this field. kind can be only one of the following:
doubleValue

number

Holds the value for a tag field with double type.

stringValue

string

Holds the value for a tag field with string type.

boolValue

boolean

Holds the value for a tag field with boolean type.

timestampValue

string (Timestamp format)

Holds the value for a tag field with timestamp type.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enumValue

object (EnumValue)

Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum.

EnumValue

Holds an enum value.

JSON representation
{
  "displayName": string
}
Fields
displayName

string

The display name of the enum value.

Methods

create

Creates a tag on an Entry.

delete

Deletes a tag.

list

Lists the tags on an Entry.

patch

Updates an existing tag.