com.google.cloud.resourcemanager.v3

Class TagBindingsClient

java.lang.Object

com.google.cloud.resourcemanager.v3.TagBindingsClient

All Implemented Interfaces:

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

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

Service Description: Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the TagBindingsClient 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
ListTagBindings	Lists the TagBindings for the given Google Cloud resource, as specified with `parent`. NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTagBindings(ListTagBindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTagBindings(ResourceName parent) listTagBindings(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. listTagBindingsPagedCallable() listTagBindingsCallable()
CreateTagBinding	Creates a TagBinding between a TagValue and a Google Cloud resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTagBindingAsync(CreateTagBindingRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createTagBindingAsync(TagBinding tagBinding) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTagBindingOperationCallable() createTagBindingCallable()
DeleteTagBinding	Deletes a TagBinding.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTagBindingAsync(DeleteTagBindingRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteTagBindingAsync(TagBindingName name) deleteTagBindingAsync(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. deleteTagBindingOperationCallable() deleteTagBindingCallable()
ListEffectiveTags	Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEffectiveTags(ListEffectiveTagsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEffectiveTags(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. listEffectiveTagsPagedCallable() listEffectiveTagsCallable()

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 TagBindingsSettings 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
 TagBindingsSettings tagBindingsSettings =
     TagBindingsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);
 

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
 TagBindingsSettings tagBindingsSettings =
     TagBindingsSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);
 

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
 TagBindingsSettings tagBindingsSettings = TagBindingsSettings.newHttpJsonBuilder().build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagBindingsClient.ListEffectiveTagsFixedSizeCollection
static class	TagBindingsClient.ListEffectiveTagsPage
static class	TagBindingsClient.ListEffectiveTagsPagedResponse
static class	TagBindingsClient.ListTagBindingsFixedSizeCollection
static class	TagBindingsClient.ListTagBindingsPage
static class	TagBindingsClient.ListTagBindingsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TagBindingsClient(TagBindingsSettings settings) Constructs an instance of TagBindingsClient, using the given settings.
protected	TagBindingsClient(TagBindingsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TagBindingsClient	create() Constructs an instance of TagBindingsClient with default settings.
static TagBindingsClient	create(TagBindingsSettings settings) Constructs an instance of TagBindingsClient, using the given settings.
static TagBindingsClient	create(TagBindingsStub stub) Constructs an instance of TagBindingsClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<TagBinding,CreateTagBindingMetadata>	createTagBindingAsync(CreateTagBindingRequest request) Creates a TagBinding between a TagValue and a Google Cloud resource.
com.google.api.gax.longrunning.OperationFuture<TagBinding,CreateTagBindingMetadata>	createTagBindingAsync(TagBinding tagBinding) Creates a TagBinding between a TagValue and a Google Cloud resource.
com.google.api.gax.rpc.UnaryCallable<CreateTagBindingRequest,com.google.longrunning.Operation>	createTagBindingCallable() Creates a TagBinding between a TagValue and a Google Cloud resource.
com.google.api.gax.rpc.OperationCallable<CreateTagBindingRequest,TagBinding,CreateTagBindingMetadata>	createTagBindingOperationCallable() Creates a TagBinding between a TagValue and a Google Cloud resource.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata>	deleteTagBindingAsync(DeleteTagBindingRequest request) Deletes a TagBinding.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata>	deleteTagBindingAsync(String name) Deletes a TagBinding.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata>	deleteTagBindingAsync(TagBindingName name) Deletes a TagBinding.
com.google.api.gax.rpc.UnaryCallable<DeleteTagBindingRequest,com.google.longrunning.Operation>	deleteTagBindingCallable() Deletes a TagBinding.
com.google.api.gax.rpc.OperationCallable<DeleteTagBindingRequest,com.google.protobuf.Empty,DeleteTagBindingMetadata>	deleteTagBindingOperationCallable() Deletes a TagBinding.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
TagBindingsSettings	getSettings()
TagBindingsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
TagBindingsClient.ListEffectiveTagsPagedResponse	listEffectiveTags(ListEffectiveTagsRequest request) Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.
TagBindingsClient.ListEffectiveTagsPagedResponse	listEffectiveTags(String parent) Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.
com.google.api.gax.rpc.UnaryCallable<ListEffectiveTagsRequest,ListEffectiveTagsResponse>	listEffectiveTagsCallable() Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.
com.google.api.gax.rpc.UnaryCallable<ListEffectiveTagsRequest,TagBindingsClient.ListEffectiveTagsPagedResponse>	listEffectiveTagsPagedCallable() Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.
TagBindingsClient.ListTagBindingsPagedResponse	listTagBindings(ListTagBindingsRequest request) Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.
TagBindingsClient.ListTagBindingsPagedResponse	listTagBindings(com.google.api.resourcenames.ResourceName parent) Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.
TagBindingsClient.ListTagBindingsPagedResponse	listTagBindings(String parent) Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.
com.google.api.gax.rpc.UnaryCallable<ListTagBindingsRequest,ListTagBindingsResponse>	listTagBindingsCallable() Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.
com.google.api.gax.rpc.UnaryCallable<ListTagBindingsRequest,TagBindingsClient.ListTagBindingsPagedResponse>	listTagBindingsPagedCallable() Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

TagBindingsClient

protected TagBindingsClient(TagBindingsSettings settings)
                     throws IOException

Constructs an instance of TagBindingsClient, 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

TagBindingsClient

protected TagBindingsClient(TagBindingsStub stub)

Method Detail

create

public static final TagBindingsClient create()
                                      throws IOException

Constructs an instance of TagBindingsClient with default settings.

Throws:

IOException

create

public static final TagBindingsClient create(TagBindingsSettings settings)
                                      throws IOException

Constructs an instance of TagBindingsClient, 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 TagBindingsClient create(TagBindingsStub stub)

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

getSettings

public final TagBindingsSettings getSettings()

getStub

public TagBindingsStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listTagBindings

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(com.google.api.resourcenames.ResourceName parent)

Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.

NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTagBindings

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(String parent)

Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.

NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   String parent = FolderName.of("[FOLDER]").toString();
   for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTagBindings

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(ListTagBindingsRequest request)

Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.

NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListTagBindingsRequest request =
       ListTagBindingsRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TagBinding element : tagBindingsClient.listTagBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listTagBindingsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagBindingsRequest,TagBindingsClient.ListTagBindingsPagedResponse> listTagBindingsPagedCallable()

Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.

NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListTagBindingsRequest request =
       ListTagBindingsRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TagBinding> future =
       tagBindingsClient.listTagBindingsPagedCallable().futureCall(request);
   // Do something.
   for (TagBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTagBindingsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagBindingsRequest,ListTagBindingsResponse> listTagBindingsCallable()

Lists the TagBindings for the given Google Cloud resource, as specified with `parent`.

NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListTagBindingsRequest request =
       ListTagBindingsRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTagBindingsResponse response =
         tagBindingsClient.listTagBindingsCallable().call(request);
     for (TagBinding element : response.getTagBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

createTagBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<TagBinding,CreateTagBindingMetadata> createTagBindingAsync(TagBinding tagBinding)

Creates a TagBinding between a TagValue and a Google Cloud resource.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   TagBinding tagBinding = TagBinding.newBuilder().build();
   TagBinding response = tagBindingsClient.createTagBindingAsync(tagBinding).get();
 }
 

Parameters:

tagBinding - Required. The TagBinding to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTagBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<TagBinding,CreateTagBindingMetadata> createTagBindingAsync(CreateTagBindingRequest request)

Creates a TagBinding between a TagValue and a Google Cloud resource.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   CreateTagBindingRequest request =
       CreateTagBindingRequest.newBuilder()
           .setTagBinding(TagBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   TagBinding response = tagBindingsClient.createTagBindingAsync(request).get();
 }
 

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

createTagBindingOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateTagBindingRequest,TagBinding,CreateTagBindingMetadata> createTagBindingOperationCallable()

Creates a TagBinding between a TagValue and a Google Cloud resource.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   CreateTagBindingRequest request =
       CreateTagBindingRequest.newBuilder()
           .setTagBinding(TagBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<TagBinding, CreateTagBindingMetadata> future =
       tagBindingsClient.createTagBindingOperationCallable().futureCall(request);
   // Do something.
   TagBinding response = future.get();
 }
 

createTagBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTagBindingRequest,com.google.longrunning.Operation> createTagBindingCallable()

Creates a TagBinding between a TagValue and a Google Cloud resource.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   CreateTagBindingRequest request =
       CreateTagBindingRequest.newBuilder()
           .setTagBinding(TagBinding.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       tagBindingsClient.createTagBindingCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteTagBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata> deleteTagBindingAsync(TagBindingName name)

Deletes a TagBinding.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   TagBindingName name = TagBindingName.of("[TAG_BINDING]");
   tagBindingsClient.deleteTagBindingAsync(name).get();
 }
 

Parameters:

name - Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTagBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata> deleteTagBindingAsync(String name)

Deletes a TagBinding.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   String name = TagBindingName.of("[TAG_BINDING]").toString();
   tagBindingsClient.deleteTagBindingAsync(name).get();
 }
 

Parameters:

name - Required. The name of the TagBinding. This is a String of the form: `tagBindings/{id}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTagBindingAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTagBindingMetadata> deleteTagBindingAsync(DeleteTagBindingRequest request)

Deletes a TagBinding.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   DeleteTagBindingRequest request =
       DeleteTagBindingRequest.newBuilder()
           .setName(TagBindingName.of("[TAG_BINDING]").toString())
           .build();
   tagBindingsClient.deleteTagBindingAsync(request).get();
 }
 

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

deleteTagBindingOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteTagBindingRequest,com.google.protobuf.Empty,DeleteTagBindingMetadata> deleteTagBindingOperationCallable()

Deletes a TagBinding.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   DeleteTagBindingRequest request =
       DeleteTagBindingRequest.newBuilder()
           .setName(TagBindingName.of("[TAG_BINDING]").toString())
           .build();
   OperationFuture<Empty, DeleteTagBindingMetadata> future =
       tagBindingsClient.deleteTagBindingOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteTagBindingCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTagBindingRequest,com.google.longrunning.Operation> deleteTagBindingCallable()

Deletes a TagBinding.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   DeleteTagBindingRequest request =
       DeleteTagBindingRequest.newBuilder()
           .setName(TagBindingName.of("[TAG_BINDING]").toString())
           .build();
   ApiFuture<Operation> future =
       tagBindingsClient.deleteTagBindingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listEffectiveTags

public final TagBindingsClient.ListEffectiveTagsPagedResponse listEffectiveTags(String parent)

Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   String parent = "parent-995424086";
   for (EffectiveTag element : tagBindingsClient.listEffectiveTags(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The full resource name of a resource for which you want to list the effective tags. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEffectiveTags

public final TagBindingsClient.ListEffectiveTagsPagedResponse listEffectiveTags(ListEffectiveTagsRequest request)

Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListEffectiveTagsRequest request =
       ListEffectiveTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EffectiveTag element : tagBindingsClient.listEffectiveTags(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listEffectiveTagsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEffectiveTagsRequest,TagBindingsClient.ListEffectiveTagsPagedResponse> listEffectiveTagsPagedCallable()

Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListEffectiveTagsRequest request =
       ListEffectiveTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EffectiveTag> future =
       tagBindingsClient.listEffectiveTagsPagedCallable().futureCall(request);
   // Do something.
   for (EffectiveTag element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEffectiveTagsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEffectiveTagsRequest,ListEffectiveTagsResponse> listEffectiveTagsCallable()

Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ListEffectiveTagsRequest request =
       ListEffectiveTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEffectiveTagsResponse response =
         tagBindingsClient.listEffectiveTagsCallable().call(request);
     for (EffectiveTag element : response.getEffectiveTagsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

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