tag_templates

Creates, updates, deletes, gets or lists a tag_templates resource.

Overview

Name	tag_templates
Type	Resource
Id	google.datacatalog.tag_templates

Fields

Name	Datatype	Description
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.
dataplexTransferStatus	string	Optional. Transfer status of the TagTemplate
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.
fields	object	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.
isPubliclyReadable	boolean	Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in 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.

Methods

Name	Accessible by	Required Params	Description
projects_locations_tag_templates_get	SELECT	locationsId, projectsId, tagTemplatesId	Gets a tag template.
projects_locations_tag_templates_create	INSERT	locationsId, projectsId	Creates a tag template. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
projects_locations_tag_templates_delete	DELETE	locationsId, projectsId, tagTemplatesId	Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.
projects_locations_tag_templates_patch	UPDATE	locationsId, projectsId, tagTemplatesId	Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

SELECT examples

Gets a tag template.

SELECT
name,
dataplexTransferStatus,
displayName,
fields,
isPubliclyReadable
FROM google.datacatalog.tag_templates
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tagTemplatesId = '{{ tagTemplatesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new tag_templates resource.

All Properties

/*+ create */
INSERT INTO google.datacatalog.tag_templates (
locationsId,
projectsId,
name,
displayName,
isPubliclyReadable,
fields,
dataplexTransferStatus
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
{{ isPubliclyReadable }},
'{{ fields }}',
'{{ dataplexTransferStatus }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: isPubliclyReadable
      value: boolean
    - name: fields
      value: object
    - name: dataplexTransferStatus
      value: string

UPDATE example

Updates a tag_templates resource.

/*+ update */
UPDATE google.datacatalog.tag_templates
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
isPubliclyReadable = true|false,
fields = '{{ fields }}',
dataplexTransferStatus = '{{ dataplexTransferStatus }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tagTemplatesId = '{{ tagTemplatesId }}';

DELETE example

Deletes the specified tag_templates resource.

/*+ delete */
DELETE FROM google.datacatalog.tag_templates
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tagTemplatesId = '{{ tagTemplatesId }}';