- 1.59.0 (latest)
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
| GitHub Repository | Product Reference |
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().
| 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Static Methods
create()
public static final PolicyTagManagerSerializationClient create()Constructs an instance of PolicyTagManagerSerializationClient with default settings.
| Returns | |
|---|---|
| Type | Description |
PolicyTagManagerSerializationClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PolicyTagManagerSerializationSettings settings)
public static final PolicyTagManagerSerializationClient create(PolicyTagManagerSerializationSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
PolicyTagManagerSerializationSettings |
| Returns | |
|---|---|
| Type | Description |
PolicyTagManagerSerializationClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PolicyTagManagerSerializationStub stub)
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).
| Parameter | |
|---|---|
| Name | Description |
stub |
PolicyTagManagerSerializationStub |
| Returns | |
|---|---|
| Type | Description |
PolicyTagManagerSerializationClient |
|
Constructors
PolicyTagManagerSerializationClient(PolicyTagManagerSerializationSettings settings)
protected PolicyTagManagerSerializationClient(PolicyTagManagerSerializationSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
PolicyTagManagerSerializationSettings |
PolicyTagManagerSerializationClient(PolicyTagManagerSerializationStub stub)
protected PolicyTagManagerSerializationClient(PolicyTagManagerSerializationStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
PolicyTagManagerSerializationStub |
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()exportTaxonomies(ExportTaxonomiesRequest request)
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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
ExportTaxonomiesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ExportTaxonomiesResponse |
|
exportTaxonomiesCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ExportTaxonomiesRequest,ExportTaxonomiesResponse> |
|
getSettings()
public final PolicyTagManagerSerializationSettings getSettings()| Returns | |
|---|---|
| Type | Description |
PolicyTagManagerSerializationSettings |
|
getStub()
public PolicyTagManagerSerializationStub getStub()| Returns | |
|---|---|
| Type | Description |
PolicyTagManagerSerializationStub |
|
importTaxonomies(ImportTaxonomiesRequest request)
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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
ImportTaxonomiesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ImportTaxonomiesResponse |
|
importTaxonomiesCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ImportTaxonomiesRequest,ImportTaxonomiesResponse> |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()