com.databricks.sdk.service.catalog

Interface EntityTagAssignmentsService

@Generated
public interface EntityTagAssignmentsService

Tags are attributes that include keys and optional values that you can use to organize and categorize entities in Unity Catalog. Entity tagging is currently supported on catalogs, schemas, tables (including views), columns, volumes. With these APIs, users can create, update, delete, and list tag assignments across Unity Catalog entities

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
EntityTagAssignment	create(CreateEntityTagAssignmentRequest createEntityTagAssignmentRequest) Creates a tag assignment for an Unity Catalog entity.
void	delete(DeleteEntityTagAssignmentRequest deleteEntityTagAssignmentRequest) Deletes a tag assignment for an Unity Catalog entity by its key.
EntityTagAssignment	get(GetEntityTagAssignmentRequest getEntityTagAssignmentRequest) Gets a tag assignment for an Unity Catalog entity by tag key.
ListEntityTagAssignmentsResponse	list(ListEntityTagAssignmentsRequest listEntityTagAssignmentsRequest) List tag assignments for an Unity Catalog entity
EntityTagAssignment	update(UpdateEntityTagAssignmentRequest updateEntityTagAssignmentRequest) Updates an existing tag assignment for an Unity Catalog entity.

Method Detail

create

EntityTagAssignment create(CreateEntityTagAssignmentRequest createEntityTagAssignmentRequest)

Creates a tag assignment for an Unity Catalog entity.

To add tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE CATALOG** on the entity's parent catalog

To add a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions].

[Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions

delete

void delete(DeleteEntityTagAssignmentRequest deleteEntityTagAssignmentRequest)

Deletes a tag assignment for an Unity Catalog entity by its key.

To delete tags from Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on the entity's parent schema - **USE_CATALOG** on the entity's parent catalog

To delete a governed tag from Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions].

[Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions

get

EntityTagAssignment get(GetEntityTagAssignmentRequest getEntityTagAssignmentRequest)

Gets a tag assignment for an Unity Catalog entity by tag key.

list

ListEntityTagAssignmentsResponse list(ListEntityTagAssignmentsRequest listEntityTagAssignmentsRequest)

List tag assignments for an Unity Catalog entity

PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

EntityTagAssignment update(UpdateEntityTagAssignmentRequest updateEntityTagAssignmentRequest)

Updates an existing tag assignment for an Unity Catalog entity.

To update tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE CATALOG** on the entity's parent catalog

To update a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions].

[Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions