Skip to main content

tags

Overview

Nametags
TypeResource
Idconfluent.catalog.tags

Fields

NameDatatypeDescription
attributesobjectThe tag attributes
entityGuidstringThe internal entity guid
entityNamestringThe qualified name of the entity
entityStatusstringThe entity status
entityTypestringThe entity type
errorobjectError message of this operation
propagatebooleanWhether to propagate the tag
removePropagationsOnEntityDeletebooleanWhether to remove propagations on entity delete
typeNamestringThe tag name
validityPeriodsarrayThe validity periods

Methods

NameAccessible byRequired ParamsDescription
get_tagsSELECTqualifiedName, typeNameGenerally Available

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

Bulk API to create multiple tags.
delete_tagDELETEqualifiedName, tagName, typeNameGenerally Available

Delete a tag for an entity.
update_tagsEXECGenerally Available

Bulk API to update multiple tags.