com.google.cloud.datacatalog.v1beta1

Class PolicyTagManagerSerializationClient

java.lang.Object

com.google.cloud.datacatalog.v1beta1.PolicyTagManagerSerializationClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @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 clients to manipulate their taxonomies and policy tags data with serialized format.

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()) {
   ImportTaxonomiesRequest request =
       ImportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ImportTaxonomiesResponse response =
       policyTagManagerSerializationClient.importTaxonomies(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
ImportTaxonomies	Imports all taxonomies and their policy tags to a project as new taxonomies. This method provides a bulk taxonomy / policy tag creation using nested proto structure.	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 all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future 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

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 all taxonomies and their policy tags in a project.
com.google.api.gax.rpc.UnaryCallable<ExportTaxonomiesRequest,ExportTaxonomiesResponse>	exportTaxonomiesCallable() Exports all taxonomies and their policy tags in a project.
PolicyTagManagerSerializationSettings	getSettings()
PolicyTagManagerSerializationStub	getStub()
ImportTaxonomiesResponse	importTaxonomies(ImportTaxonomiesRequest request) Imports all taxonomies and their policy tags to a project as new taxonomies.
com.google.api.gax.rpc.UnaryCallable<ImportTaxonomiesRequest,ImportTaxonomiesResponse>	importTaxonomiesCallable() Imports all taxonomies and their policy tags to a project as new taxonomies.
boolean	isShutdown()
boolean	isTerminated()
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()

importTaxonomies

public final ImportTaxonomiesResponse importTaxonomies(ImportTaxonomiesRequest request)

Imports all taxonomies and their policy tags to a project as new taxonomies.

This method provides a bulk taxonomy / policy tag creation using nested proto structure.

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()

Imports all taxonomies and their policy tags to a project as new taxonomies.

This method provides a bulk taxonomy / policy tag creation using nested proto structure.

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 all taxonomies and their policy tags in a project.

This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future 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 all taxonomies and their policy tags in a project.

This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future 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