PolicyTagManagerSerializationClient (Google Cloud Data Catalog 1.43.0 API)

java.lang.Object
- com.google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PolicyTagManagerSerializationClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ReplaceTaxonomyRequest request =
       ReplaceTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
           .build();
   Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
 }

Note: close() needs to be called on the PolicyTagManagerSerializationClient 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
ReplaceTaxonomy	Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.	Request object method variants only take one parameter, a request object, which must be constructed before the call. replaceTaxonomy(ReplaceTaxonomyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. replaceTaxonomyCallable()
ImportTaxonomies	Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importTaxonomies(ImportTaxonomiesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importTaxonomiesCallable()
ExportTaxonomies	Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.	Request object method variants only take one parameter, a request object, which must be constructed before the call. exportTaxonomies(ExportTaxonomiesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportTaxonomiesCallable()

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 PolicyTagManagerSerializationSettings 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
 PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     PolicyTagManagerSerializationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);

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
 PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     PolicyTagManagerSerializationSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);

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
 PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     PolicyTagManagerSerializationSettings.newHttpJsonBuilder().build();
 PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PolicyTagManagerSerializationClient(PolicyTagManagerSerializationSettings settings)` Constructs an instance of PolicyTagManagerSerializationClient, using the given settings.
`protected`	`PolicyTagManagerSerializationClient(PolicyTagManagerSerializationStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static PolicyTagManagerSerializationClient`	`create()` Constructs an instance of PolicyTagManagerSerializationClient with default settings.
`static PolicyTagManagerSerializationClient`	`create(PolicyTagManagerSerializationSettings settings)` Constructs an instance of PolicyTagManagerSerializationClient, using the given settings.
`static PolicyTagManagerSerializationClient`	`create(PolicyTagManagerSerializationStub stub)` Constructs an instance of PolicyTagManagerSerializationClient, using the given stub for making calls.
`ExportTaxonomiesResponse`	`exportTaxonomies(ExportTaxonomiesRequest request)` Exports taxonomies in the requested type and returns them, including their policy tags.
`com.google.api.gax.rpc.UnaryCallable<ExportTaxonomiesRequest,ExportTaxonomiesResponse>`	`exportTaxonomiesCallable()` Exports taxonomies in the requested type and returns them, including their policy tags.
`PolicyTagManagerSerializationSettings`	`getSettings()`
`PolicyTagManagerSerializationStub`	`getStub()`
`ImportTaxonomiesResponse`	`importTaxonomies(ImportTaxonomiesRequest request)` Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.
`com.google.api.gax.rpc.UnaryCallable<ImportTaxonomiesRequest,ImportTaxonomiesResponse>`	`importTaxonomiesCallable()` Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`Taxonomy`	`replaceTaxonomy(ReplaceTaxonomyRequest request)` Replaces (updates) a taxonomy and all its policy tags.
`com.google.api.gax.rpc.UnaryCallable<ReplaceTaxonomyRequest,Taxonomy>`	`replaceTaxonomyCallable()` Replaces (updates) a taxonomy and all its policy tags.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PolicyTagManagerSerializationClient
```
protected PolicyTagManagerSerializationClient(PolicyTagManagerSerializationSettings settings)
                                       throws IOException
```
  Constructs an instance of PolicyTagManagerSerializationClient, 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.
  
  Throws:
  
  IOException
- PolicyTagManagerSerializationClient
```
protected PolicyTagManagerSerializationClient(PolicyTagManagerSerializationStub stub)
```

Method Detail

create

public static final PolicyTagManagerSerializationClient create()
                                                        throws IOException

Constructs an instance of PolicyTagManagerSerializationClient with default settings.

Throws:: IOException

create
```
public static final PolicyTagManagerSerializationClient create(PolicyTagManagerSerializationSettings settings)
                                                        throws IOException
```
Constructs an instance of PolicyTagManagerSerializationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final PolicyTagManagerSerializationClient create(PolicyTagManagerSerializationStub stub)
```
Constructs an instance of PolicyTagManagerSerializationClient, using the given stub for making calls. This is for advanced usage - prefer using create(PolicyTagManagerSerializationSettings).

getSettings

public final PolicyTagManagerSerializationSettings getSettings()

getStub

public PolicyTagManagerSerializationStub getStub()

replaceTaxonomy

public final Taxonomy replaceTaxonomy(ReplaceTaxonomyRequest request)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.

This operation automatically does the following:

- Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ReplaceTaxonomyRequest request =
       ReplaceTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
           .build();
   Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

replaceTaxonomyCallable

public final com.google.api.gax.rpc.UnaryCallable<ReplaceTaxonomyRequest,Taxonomy> replaceTaxonomyCallable()

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.

This operation automatically does the following:

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ReplaceTaxonomyRequest request =
       ReplaceTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
           .build();
   ApiFuture<Taxonomy> future =
       policyTagManagerSerializationClient.replaceTaxonomyCallable().futureCall(request);
   // Do something.
   Taxonomy response = future.get();
 }

importTaxonomies

public final ImportTaxonomiesResponse importTaxonomies(ImportTaxonomiesRequest request)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ImportTaxonomiesRequest request =
       ImportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ImportTaxonomiesResponse response =
       policyTagManagerSerializationClient.importTaxonomies(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importTaxonomiesCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportTaxonomiesRequest,ImportTaxonomiesResponse> importTaxonomiesCallable()

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ImportTaxonomiesRequest request =
       ImportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ImportTaxonomiesResponse> future =
       policyTagManagerSerializationClient.importTaxonomiesCallable().futureCall(request);
   // Do something.
   ImportTaxonomiesResponse response = future.get();
 }

exportTaxonomies

public final ExportTaxonomiesResponse exportTaxonomies(ExportTaxonomiesRequest request)

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ExportTaxonomiesRequest request =
       ExportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllTaxonomies(new ArrayList<String>())
           .build();
   ExportTaxonomiesResponse response =
       policyTagManagerSerializationClient.exportTaxonomies(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

exportTaxonomiesCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportTaxonomiesRequest,ExportTaxonomiesResponse> exportTaxonomiesCallable()

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.

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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ExportTaxonomiesRequest request =
       ExportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllTaxonomies(new ArrayList<String>())
           .build();
   ApiFuture<ExportTaxonomiesResponse> future =
       policyTagManagerSerializationClient.exportTaxonomiesCallable().futureCall(request);
   // Do something.
   ExportTaxonomiesResponse response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class PolicyTagManagerSerializationClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicyTagManagerSerializationClient

PolicyTagManagerSerializationClient

Method Detail

create

create

create

getSettings

getStub

replaceTaxonomy

replaceTaxonomyCallable

importTaxonomies

importTaxonomiesCallable

exportTaxonomies

exportTaxonomiesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination