com.databricks.sdk.service.catalog

Class EntityTagAssignmentsAPI

java.lang.Object

com.databricks.sdk.service.catalog.EntityTagAssignmentsAPI

@Generated
public class EntityTagAssignmentsAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
EntityTagAssignmentsAPI(ApiClient apiClient) Regular-use constructor
EntityTagAssignmentsAPI(EntityTagAssignmentsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
EntityTagAssignment	create(CreateEntityTagAssignmentRequest request) Creates a tag assignment for an Unity Catalog entity.
void	delete(DeleteEntityTagAssignmentRequest request) Deletes a tag assignment for an Unity Catalog entity by its key.
void	delete(String entityType, String entityName, String tagKey)
EntityTagAssignment	get(GetEntityTagAssignmentRequest request) Gets a tag assignment for an Unity Catalog entity by tag key.
EntityTagAssignment	get(String entityType, String entityName, String tagKey)
EntityTagAssignmentsService	impl()
Iterable<EntityTagAssignment>	list(ListEntityTagAssignmentsRequest request) List tag assignments for an Unity Catalog entity
Iterable<EntityTagAssignment>	list(String entityType, String entityName)
EntityTagAssignment	update(UpdateEntityTagAssignmentRequest request) Updates an existing tag assignment for an Unity Catalog entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityTagAssignmentsAPI

public EntityTagAssignmentsAPI(ApiClient apiClient)

Regular-use constructor

EntityTagAssignmentsAPI

public EntityTagAssignmentsAPI(EntityTagAssignmentsService mock)

Constructor for mocks

Method Detail

create

public EntityTagAssignment create(CreateEntityTagAssignmentRequest request)

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

public void delete(String entityType,
                   String entityName,
                   String tagKey)

delete

public void delete(DeleteEntityTagAssignmentRequest request)

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

public EntityTagAssignment get(String entityType,
                               String entityName,
                               String tagKey)

get

public EntityTagAssignment get(GetEntityTagAssignmentRequest request)

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

list

public Iterable<EntityTagAssignment> list(String entityType,
                                          String entityName)

list

public Iterable<EntityTagAssignment> list(ListEntityTagAssignmentsRequest request)

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

public EntityTagAssignment update(UpdateEntityTagAssignmentRequest request)

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

impl

public EntityTagAssignmentsService impl()