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

string

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.

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.

TagField

Contains the value and additional information on 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)
  },
  "richtextValue": string
  // 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. Can be set by 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 don't have to be sequential.

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

number

The value of a tag field with a double type.

stringValue

string

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

boolValue

boolean

The value of a tag field with a boolean type.

timestampValue

string (Timestamp format)

The value of a tag field with a 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)

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

richtextValue

string

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

EnumValue

An enum value.

JSON representation
{
  "displayName": string
}
Fields
displayName

string

The display name of the enum value.

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.