REST Resource: projects.locations.tagTemplates

Resource: TagTemplate

A tag template defines a tag that can have one or more typed fields.

The template is used to create tags that are attached to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a permission to use the tag template to tag resources.

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

string

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

Note: The tag template itself and its child resources might not be stored in the location specified in its name.
displayName

string

Display name for this template. Defaults to an empty string.

The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
isPubliclyReadable

boolean

Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.ListTags] API response.

Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.
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. The map must contain at least one field and at most 500 fields.

The keys to this map are tag template field IDs. The IDs have the following limitations:

  • Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
  • Must be at least 1 character and at most 64 characters long.
  • Must start with a letter or underscore.
dataplexTransferStatus

enum (DataplexTransferStatus)

Optional. Transfer status of the TagTemplate

Methods

create

 Creates a tag template.

delete

 Deletes a tag template and all tags that use it.

get

 Gets a tag template.

getIamPolicy

 Gets the access control policy for a resource.

patch

 Updates a tag template.

setIamPolicy

 Sets an access control policy for a resource.

testIamPermissions

 Gets your permissions on a resource.