tags

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

Overview

Name	tags
Type	Resource
Id	confluent.catalog.tags

Fields

Name	Datatype	Description
attributes	object	The tag attributes
entityGuid	string	The internal entity guid
entityName	string	The qualified name of the entity
entityStatus	string	The entity status
entityType	string	The entity type
error	object	Error message of this operation
propagate	boolean	Whether to propagate the tag
removePropagationsOnEntityDelete	boolean	Whether to remove propagations on entity delete
typeName	string	The tag name
validityPeriods	array	The validity periods

Methods

Name	Accessible by	Required Params	Description
get_tags	SELECT	qualifiedName, typeName	Gets the list of tags for a given entity represented by a qualified name.
create_tags	INSERT		Bulk API to create multiple tags.
delete_tag	DELETE	qualifiedName, tagName, typeName	Delete a tag for an entity.
update_tags	EXEC		Bulk API to update multiple tags.

SELECT examples

Gets the list of tags for a given entity represented by a qualified name.

SELECT
attributes,
entityGuid,
entityName,
entityStatus,
entityType,
error,
propagate,
removePropagationsOnEntityDelete,
typeName,
validityPeriods
FROM confluent.catalog.tags
WHERE qualifiedName = '{{ qualifiedName }}'
AND typeName = '{{ typeName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO confluent.catalog.tags (

)
SELECT 

;

Manifest

- name: tags
  props: []

DELETE example

Deletes the specified tags resource.

/*+ delete */
DELETE FROM confluent.catalog.tags
WHERE qualifiedName = '{{ qualifiedName }}'
AND tagName = '{{ tagName }}'
AND typeName = '{{ typeName }}';