REST Resource: projects.locations.tagTemplates

Resource: TagTemplate

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.

JSON representation 
{
  "name": string,
  "displayName": string,
  "fields": {
    string: {
      object (TagTemplateField)
    },
    ...
  },
  "dataplexTransferStatus": enum (DataplexTransferStatus)
}
Fields
name

string

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
displayName

string

The display name for this template. Defaults to an empty string.
fields

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

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
dataplexTransferStatus

enum (DataplexTransferStatus)

Output only. Transfer status of the TagTemplate

DataplexTransferStatus

This enum describes TagTemplate transfer status to Dataplex service.

Enums
DATAPLEX_TRANSFER_STATUS_UNSPECIFIED Default value. TagTemplate and its tags are only visible and editable in DataCatalog.
MIGRATED

TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex. Deprecated: Individual TagTemplate migration is deprecated in favor of organization or project wide TagTemplate migration opt-in.

Methods

create

 Creates a tag template.

delete

 Deletes a tag template and all tags using the template.

get

 Gets a tag template.

getIamPolicy

 Gets the access control policy for a resource.

patch

 Updates a tag template.

setIamPolicy

 Sets the access control policy for a resource.

testIamPermissions

 Returns the caller's permissions on a resource.