com.databricks.sdk.service.tags

Class TagPoliciesAPI

java.lang.Object

com.databricks.sdk.service.tags.TagPoliciesAPI

@Generated
public class TagPoliciesAPI
extends Object

The Tag Policy API allows you to manage policies for governed tags in Databricks. For Terraform usage, see the [Tag Policy Terraform documentation]. Permissions for tag policies can be managed using the [Account Access Control Proxy API].

[Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy

Constructor Summary

Constructors

Constructor and Description
TagPoliciesAPI(ApiClient apiClient) Regular-use constructor
TagPoliciesAPI(TagPoliciesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
TagPolicy	createTagPolicy(CreateTagPolicyRequest request) Creates a new tag policy, making the associated tag key governed.
void	deleteTagPolicy(DeleteTagPolicyRequest request) Deletes a tag policy by its associated governed tag's key, leaving that tag key ungoverned.
void	deleteTagPolicy(String tagKey)
TagPolicy	getTagPolicy(GetTagPolicyRequest request) Gets a single tag policy by its associated governed tag's key.
TagPolicy	getTagPolicy(String tagKey)
TagPoliciesService	impl()
Iterable<TagPolicy>	listTagPolicies(ListTagPoliciesRequest request) Lists the tag policies for all governed tags in the account.
TagPolicy	updateTagPolicy(UpdateTagPolicyRequest request) Updates an existing tag policy for a single governed tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagPoliciesAPI

public TagPoliciesAPI(ApiClient apiClient)

Regular-use constructor

TagPoliciesAPI

public TagPoliciesAPI(TagPoliciesService mock)

Constructor for mocks

Method Detail

createTagPolicy

public TagPolicy createTagPolicy(CreateTagPolicyRequest request)

Creates a new tag policy, making the associated tag key governed. For Terraform usage, see the [Tag Policy Terraform documentation]. To manage permissions for tag policies, use the [Account Access Control Proxy API].

[Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy

deleteTagPolicy

public void deleteTagPolicy(String tagKey)

deleteTagPolicy

public void deleteTagPolicy(DeleteTagPolicyRequest request)

Deletes a tag policy by its associated governed tag's key, leaving that tag key ungoverned. For Terraform usage, see the [Tag Policy Terraform documentation].

[Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy

getTagPolicy

public TagPolicy getTagPolicy(String tagKey)

getTagPolicy

public TagPolicy getTagPolicy(GetTagPolicyRequest request)

Gets a single tag policy by its associated governed tag's key. For Terraform usage, see the [Tag Policy Terraform documentation]. To list granted permissions for tag policies, use the [Account Access Control Proxy API].

[Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policy

listTagPolicies

public Iterable<TagPolicy> listTagPolicies(ListTagPoliciesRequest request)

Lists the tag policies for all governed tags in the account. For Terraform usage, see the [Tag Policy Terraform documentation]. To list granted permissions for tag policies, use the [Account Access Control Proxy API].

[Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policies

updateTagPolicy

public TagPolicy updateTagPolicy(UpdateTagPolicyRequest request)

Updates an existing tag policy for a single governed tag. For Terraform usage, see the [Tag Policy Terraform documentation]. To manage permissions for tag policies, use the [Account Access Control Proxy API].

[Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy

impl

public TagPoliciesService impl()