Class PolicyTagManagerClient (1.60.0)

GitHub RepositoryProduct Reference

Service Description: Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Taxonomy taxonomy = Taxonomy.newBuilder().build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
 }
 

Note: close() needs to be called on the PolicyTagManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateTaxonomy

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createTaxonomy(CreateTaxonomyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createTaxonomy(LocationName parent, Taxonomy taxonomy)

  • createTaxonomy(String parent, Taxonomy taxonomy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createTaxonomyCallable()

DeleteTaxonomy

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteTaxonomy(DeleteTaxonomyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteTaxonomy(TaxonomyName name)

  • deleteTaxonomy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteTaxonomyCallable()

UpdateTaxonomy

Updates a taxonomy, including its display name, description, and activated policy types.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTaxonomy(UpdateTaxonomyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateTaxonomy(Taxonomy taxonomy)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateTaxonomyCallable()

ListTaxonomies

Lists all taxonomies in a project in a particular location that you have a permission to view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTaxonomies(ListTaxonomiesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTaxonomies(LocationName parent)

  • listTaxonomies(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listTaxonomiesPagedCallable()

  • listTaxonomiesCallable()

GetTaxonomy

Gets a taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTaxonomy(GetTaxonomyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTaxonomy(TaxonomyName name)

  • getTaxonomy(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTaxonomyCallable()

CreatePolicyTag

Creates a policy tag in a taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPolicyTag(CreatePolicyTagRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createPolicyTag(TaxonomyName parent, PolicyTag policyTag)

  • createPolicyTag(String parent, PolicyTag policyTag)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPolicyTagCallable()

DeletePolicyTag

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePolicyTag(DeletePolicyTagRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deletePolicyTag(PolicyTagName name)

  • deletePolicyTag(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePolicyTagCallable()

UpdatePolicyTag

Updates a policy tag, including its display name, description, and parent policy tag.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePolicyTag(UpdatePolicyTagRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updatePolicyTag(PolicyTag policyTag)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePolicyTagCallable()

ListPolicyTags

Lists all policy tags in a taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPolicyTags(ListPolicyTagsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPolicyTags(TaxonomyName parent)

  • listPolicyTags(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPolicyTagsPagedCallable()

  • listPolicyTagsCallable()

GetPolicyTag

Gets a policy tag.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPolicyTag(GetPolicyTagRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPolicyTag(PolicyTagName name)

  • getPolicyTag(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPolicyTagCallable()

GetIamPolicy

Gets the IAM policy for a policy tag or a taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

SetIamPolicy

Sets the IAM policy for a policy tag or a taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

TestIamPermissions

Returns your permissions on a specified policy tag or taxonomy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of PolicyTagManagerSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PolicyTagManagerSettings policyTagManagerSettings =
     PolicyTagManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyTagManagerClient policyTagManagerClient =
     PolicyTagManagerClient.create(policyTagManagerSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PolicyTagManagerSettings policyTagManagerSettings =
     PolicyTagManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyTagManagerClient policyTagManagerClient =
     PolicyTagManagerClient.create(policyTagManagerSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PolicyTagManagerSettings policyTagManagerSettings =
     PolicyTagManagerSettings.newHttpJsonBuilder().build();
 PolicyTagManagerClient policyTagManagerClient =
     PolicyTagManagerClient.create(policyTagManagerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > PolicyTagManagerClient

Static Methods

create()

public static final PolicyTagManagerClient create()

Constructs an instance of PolicyTagManagerClient with default settings.

Returns
Type Description
PolicyTagManagerClient
Exceptions
Type Description
IOException

create(PolicyTagManagerSettings settings)

public static final PolicyTagManagerClient create(PolicyTagManagerSettings settings)

Constructs an instance of PolicyTagManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings PolicyTagManagerSettings
Returns
Type Description
PolicyTagManagerClient
Exceptions
Type Description
IOException

create(PolicyTagManagerStub stub)

public static final PolicyTagManagerClient create(PolicyTagManagerStub stub)

Constructs an instance of PolicyTagManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(PolicyTagManagerSettings).

Parameter
Name Description
stub PolicyTagManagerStub
Returns
Type Description
PolicyTagManagerClient

Constructors

PolicyTagManagerClient(PolicyTagManagerSettings settings)

protected PolicyTagManagerClient(PolicyTagManagerSettings settings)

Constructs an instance of PolicyTagManagerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings PolicyTagManagerSettings

PolicyTagManagerClient(PolicyTagManagerStub stub)

protected PolicyTagManagerClient(PolicyTagManagerStub stub)
Parameter
Name Description
stub PolicyTagManagerStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createPolicyTag(CreatePolicyTagRequest request)

public final PolicyTag createPolicyTag(CreatePolicyTagRequest request)

Creates a policy tag in a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   CreatePolicyTagRequest request =
       CreatePolicyTagRequest.newBuilder()
           .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setPolicyTag(PolicyTag.newBuilder().build())
           .build();
   PolicyTag response = policyTagManagerClient.createPolicyTag(request);
 }
 
Parameter
Name Description
request CreatePolicyTagRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PolicyTag

createPolicyTag(TaxonomyName parent, PolicyTag policyTag)

public final PolicyTag createPolicyTag(TaxonomyName parent, PolicyTag policyTag)

Creates a policy tag in a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   TaxonomyName parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
   PolicyTag policyTag = PolicyTag.newBuilder().build();
   PolicyTag response = policyTagManagerClient.createPolicyTag(parent, policyTag);
 }
 
Parameters
Name Description
parent TaxonomyName

Required. Resource name of the taxonomy that the policy tag will belong to.

policyTag PolicyTag

The policy tag to create.

Returns
Type Description
PolicyTag

createPolicyTag(String parent, PolicyTag policyTag)

public final PolicyTag createPolicyTag(String parent, PolicyTag policyTag)

Creates a policy tag in a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   String parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
   PolicyTag policyTag = PolicyTag.newBuilder().build();
   PolicyTag response = policyTagManagerClient.createPolicyTag(parent, policyTag);
 }
 
Parameters
Name Description
parent String

Required. Resource name of the taxonomy that the policy tag will belong to.

policyTag PolicyTag

The policy tag to create.

Returns
Type Description
PolicyTag

createPolicyTagCallable()

public final UnaryCallable<CreatePolicyTagRequest,PolicyTag> createPolicyTagCallable()

Creates a policy tag in a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   CreatePolicyTagRequest request =
       CreatePolicyTagRequest.newBuilder()
           .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setPolicyTag(PolicyTag.newBuilder().build())
           .build();
   ApiFuture<PolicyTag> future =
       policyTagManagerClient.createPolicyTagCallable().futureCall(request);
   // Do something.
   PolicyTag response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePolicyTagRequest,PolicyTag>

createTaxonomy(CreateTaxonomyRequest request)

public final Taxonomy createTaxonomy(CreateTaxonomyRequest request)

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   CreateTaxonomyRequest request =
       CreateTaxonomyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTaxonomy(Taxonomy.newBuilder().build())
           .build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(request);
 }
 
Parameter
Name Description
request CreateTaxonomyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Taxonomy

createTaxonomy(LocationName parent, Taxonomy taxonomy)

public final Taxonomy createTaxonomy(LocationName parent, Taxonomy taxonomy)

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Taxonomy taxonomy = Taxonomy.newBuilder().build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
 }
 
Parameters
Name Description
parent LocationName

Required. Resource name of the project that the taxonomy will belong to.

taxonomy Taxonomy

The taxonomy to create.

Returns
Type Description
Taxonomy

createTaxonomy(String parent, Taxonomy taxonomy)

public final Taxonomy createTaxonomy(String parent, Taxonomy taxonomy)

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Taxonomy taxonomy = Taxonomy.newBuilder().build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
 }
 
Parameters
Name Description
parent String

Required. Resource name of the project that the taxonomy will belong to.

taxonomy Taxonomy

The taxonomy to create.

Returns
Type Description
Taxonomy

createTaxonomyCallable()

public final UnaryCallable<CreateTaxonomyRequest,Taxonomy> createTaxonomyCallable()

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   CreateTaxonomyRequest request =
       CreateTaxonomyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTaxonomy(Taxonomy.newBuilder().build())
           .build();
   ApiFuture<Taxonomy> future =
       policyTagManagerClient.createTaxonomyCallable().futureCall(request);
   // Do something.
   Taxonomy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateTaxonomyRequest,Taxonomy>

deletePolicyTag(DeletePolicyTagRequest request)

public final void deletePolicyTag(DeletePolicyTagRequest request)

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   DeletePolicyTagRequest request =
       DeletePolicyTagRequest.newBuilder()
           .setName(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .build();
   policyTagManagerClient.deletePolicyTag(request);
 }
 
Parameter
Name Description
request DeletePolicyTagRequest

The request object containing all of the parameters for the API call.

deletePolicyTag(PolicyTagName name)

public final void deletePolicyTag(PolicyTagName name)

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   PolicyTagName name =
       PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]");
   policyTagManagerClient.deletePolicyTag(name);
 }
 
Parameter
Name Description
name PolicyTagName

Required. Resource name of the policy tag to delete.

Note: All of its descendant policy tags are also deleted.

deletePolicyTag(String name)

public final void deletePolicyTag(String name)

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   String name =
       PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]").toString();
   policyTagManagerClient.deletePolicyTag(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of the policy tag to delete.

Note: All of its descendant policy tags are also deleted.

deletePolicyTagCallable()

public final UnaryCallable<DeletePolicyTagRequest,Empty> deletePolicyTagCallable()

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   DeletePolicyTagRequest request =
       DeletePolicyTagRequest.newBuilder()
           .setName(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       policyTagManagerClient.deletePolicyTagCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePolicyTagRequest,Empty>

deleteTaxonomy(DeleteTaxonomyRequest request)

public final void deleteTaxonomy(DeleteTaxonomyRequest request)

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   DeleteTaxonomyRequest request =
       DeleteTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .build();
   policyTagManagerClient.deleteTaxonomy(request);
 }
 
Parameter
Name Description
request DeleteTaxonomyRequest

The request object containing all of the parameters for the API call.

deleteTaxonomy(TaxonomyName name)

public final void deleteTaxonomy(TaxonomyName name)

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   TaxonomyName name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
   policyTagManagerClient.deleteTaxonomy(name);
 }
 
Parameter
Name Description
name TaxonomyName

Required. Resource name of the taxonomy to delete.

Note: All policy tags in this taxonomy are also deleted.

deleteTaxonomy(String name)

public final void deleteTaxonomy(String name)

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   String name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
   policyTagManagerClient.deleteTaxonomy(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of the taxonomy to delete.

Note: All policy tags in this taxonomy are also deleted.

deleteTaxonomyCallable()

public final UnaryCallable<DeleteTaxonomyRequest,Empty> deleteTaxonomyCallable()

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   DeleteTaxonomyRequest request =
       DeleteTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .build();
   ApiFuture<Empty> future = policyTagManagerClient.deleteTaxonomyCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteTaxonomyRequest,Empty>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM policy for a policy tag or a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = policyTagManagerClient.getIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM policy for a policy tag or a taxonomy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = policyTagManagerClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getPolicyTag(GetPolicyTagRequest request)

public final PolicyTag getPolicyTag(GetPolicyTagRequest request)

Gets a policy tag.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   GetPolicyTagRequest request =
       GetPolicyTagRequest.newBuilder()
           .setName(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .build();
   PolicyTag response = policyTagManagerClient.getPolicyTag(request);
 }
 
Parameter
Name Description
request GetPolicyTagRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PolicyTag

getPolicyTag(PolicyTagName name)

public final PolicyTag getPolicyTag(PolicyTagName name)

Gets a policy tag.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   PolicyTagName name =
       PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]");
   PolicyTag response = policyTagManagerClient.getPolicyTag(name);
 }
 
Parameter
Name Description
name PolicyTagName

Required. Resource name of the policy tag.

Returns
Type Description
PolicyTag

getPolicyTag(String name)

public final PolicyTag getPolicyTag(String name)

Gets a policy tag.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   String name =
       PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]").toString();
   PolicyTag response = policyTagManagerClient.getPolicyTag(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of the policy tag.

Returns
Type Description
PolicyTag

getPolicyTagCallable()

public final UnaryCallable<GetPolicyTagRequest,PolicyTag> getPolicyTagCallable()

Gets a policy tag.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   GetPolicyTagRequest request =
       GetPolicyTagRequest.newBuilder()
           .setName(
               PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
                   .toString())
           .build();
   ApiFuture<PolicyTag> future =
       policyTagManagerClient.getPolicyTagCallable().futureCall(request);
   // Do something.
   PolicyTag response = future.get();
 }
 
Returns