tags

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

Overview

Name	tags
Type	Resource
Id	google.datacatalog.tags

Fields

Name	Datatype	Description
name	string	Identifier. 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.
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.
fields	object	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.
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.

Methods

Name	Accessible by	Required Params	Description
projects_locations_entry_groups_entries_tags_list	SELECT	entriesId, entryGroupsId, locationsId, projectsId	Lists tags assigned to an Entry. The columns in the response are lowercased.
projects_locations_entry_groups_tags_list	SELECT	entryGroupsId, locationsId, projectsId	Lists tags assigned to an Entry. The columns in the response are lowercased.
projects_locations_entry_groups_entries_tags_create	INSERT	entriesId, entryGroupsId, locationsId, projectsId	Creates a tag and assigns it to: An Entry if the method name is projects.locations.entryGroups.entries.tags.create. Or EntryGroupif the method name is projects.locations.entryGroups.tags.create. Note: The project identified by the parent parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
projects_locations_entry_groups_tags_create	INSERT	entryGroupsId, locationsId, projectsId	Creates a tag and assigns it to: An Entry if the method name is projects.locations.entryGroups.entries.tags.create. Or EntryGroupif the method name is projects.locations.entryGroups.tags.create. Note: The project identified by the parent parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
projects_locations_entry_groups_entries_tags_delete	DELETE	entriesId, entryGroupsId, locationsId, projectsId, tagsId	Deletes a tag.
projects_locations_entry_groups_tags_delete	DELETE	entryGroupsId, locationsId, projectsId, tagsId	Deletes a tag.
projects_locations_entry_groups_entries_tags_patch	UPDATE	entriesId, entryGroupsId, locationsId, projectsId, tagsId	Updates an existing tag.
projects_locations_entry_groups_tags_patch	UPDATE	entryGroupsId, locationsId, projectsId, tagsId	Updates an existing tag.
projects_locations_entry_groups_entries_tags_reconcile	EXEC	entriesId, entryGroupsId, locationsId, projectsId	ReconcileTags creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. ReconcileTags returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message.

SELECT examples

Lists tags assigned to an Entry. The columns in the response are lowercased.

SELECT
name,
column,
fields,
template,
templateDisplayName
FROM google.datacatalog.tags
WHERE entryGroupsId = '{{ entryGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.datacatalog.tags (
entryGroupsId,
locationsId,
projectsId,
name,
template,
column,
fields
)
SELECT 
'{{ entryGroupsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ template }}',
'{{ column }}',
'{{ fields }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: template
      value: string
    - name: templateDisplayName
      value: string
    - name: column
      value: string
    - name: fields
      value: object

UPDATE example

Updates a tags resource.

/*+ update */
UPDATE google.datacatalog.tags
SET 
name = '{{ name }}',
template = '{{ template }}',
column = '{{ column }}',
fields = '{{ fields }}'
WHERE 
entryGroupsId = '{{ entryGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tagsId = '{{ tagsId }}';

DELETE example

Deletes the specified tags resource.

/*+ delete */
DELETE FROM google.datacatalog.tags
WHERE entryGroupsId = '{{ entryGroupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tagsId = '{{ tagsId }}';