tags

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

Overview

Name	tags
Type	Resource
Id	confluent.catalog.tags

Fields

The following fields are returned by SELECT queries:

get_tags

The tags

Name	Datatype	Description
attributes	string	The tag attributes (opaque JSON object)
entityGuid	string	The internal entity guid
entityName	string	The qualified name of the entity
entityStatus	string	The entity status (ACTIVE, DELETED, PURGED)
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

The following methods are available for this resource:

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
qualifiedName	string	The qualified name of the entity
tagName	string	The name of the tag
typeName	string	The type of the entity

SELECT examples

get_tags

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 typeName = '{{ typeName }}' -- required
AND qualifiedName = '{{ qualifiedName }}' -- required
;

INSERT examples

create_tags

Bulk API to create multiple tags.

INSERT INTO confluent.catalog.tags (

)
SELECT 

RETURNING
attributes,
entityGuid,
entityName,
entityStatus,
entityType,
error,
propagate,
removePropagationsOnEntityDelete,
typeName,
validityPeriods
;

Manifest

# Description fields are for documentation purposes
- name: tags
props:

REPLACE examples

update_tags

Bulk API to update multiple tags.

REPLACE confluent.catalog.tags
SET 
-- No updatable properties
RETURNING
attributes,
entityGuid,
entityName,
entityStatus,
entityType,
error,
propagate,
removePropagationsOnEntityDelete,
typeName,
validityPeriods;

DELETE examples

delete_tag

Delete a tag for an entity.

DELETE FROM confluent.catalog.tags
WHERE typeName = '{{ typeName }}' --required
AND qualifiedName = '{{ qualifiedName }}' --required
AND tagName = '{{ tagName }}' --required
;