Class TagBindingsClient (1.5.6)

Version 1.5.6

• 1.57.0 (latest)
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.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.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public class TagBindingsClient implements BackgroundResource

Service Description: Allow users to create and manage TagBindings between TagValues and different 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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns 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 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.newBuilder()
         .setTransportChannelProvider(
             TagBindingsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);
 

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

Inheritance

java.lang.Object > TagBindingsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final TagBindingsClient create()

Constructs an instance of TagBindingsClient with default settings.

Returns

Type	Description
TagBindingsClient

Exceptions

Type	Description
IOException

create(TagBindingsSettings settings)

public static final TagBindingsClient create(TagBindingsSettings settings)

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.

Parameter

Name	Description
settings	TagBindingsSettings

Returns

Type	Description
TagBindingsClient

Exceptions

Type	Description
IOException

create(TagBindingsStub stub)

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

Parameter

Name	Description
stub	TagBindingsStub

Returns

Type	Description
TagBindingsClient

Constructors

TagBindingsClient(TagBindingsSettings settings)

protected TagBindingsClient(TagBindingsSettings settings)

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.

Parameter

Name	Description
settings	TagBindingsSettings

TagBindingsClient(TagBindingsStub stub)

protected TagBindingsClient(TagBindingsStub stub)

Parameter

Name	Description
stub	TagBindingsStub

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

createTagBindingAsync(CreateTagBindingRequest request)

public final OperationFuture<TagBinding,CreateTagBindingMetadata> createTagBindingAsync(CreateTagBindingRequest request)

Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).

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

Parameter

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

Returns

Type	Description
OperationFuture<TagBinding,CreateTagBindingMetadata>

createTagBindingAsync(TagBinding tagBinding)

public final OperationFuture<TagBinding,CreateTagBindingMetadata> createTagBindingAsync(TagBinding tagBinding)

Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).

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

Parameter

Name	Description
tagBinding	TagBinding Required. The TagBinding to be created.

Returns

Type	Description
OperationFuture<TagBinding,CreateTagBindingMetadata>

createTagBindingCallable()

public final UnaryCallable<CreateTagBindingRequest,Operation> createTagBindingCallable()

Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).

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

Returns

Type	Description
UnaryCallable<CreateTagBindingRequest,Operation>

createTagBindingOperationCallable()

public final OperationCallable<CreateTagBindingRequest,TagBinding,CreateTagBindingMetadata> createTagBindingOperationCallable()

Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).

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

Returns

Type	Description
OperationCallable<CreateTagBindingRequest,TagBinding,CreateTagBindingMetadata>

deleteTagBindingAsync(DeleteTagBindingRequest request)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteTagBindingMetadata>

deleteTagBindingAsync(TagBindingName name)

public final OperationFuture<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();
 }
 

Parameter

Name	Description
name	TagBindingName 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).

Returns

Type	Description
OperationFuture<Empty,DeleteTagBindingMetadata>

deleteTagBindingAsync(String name)

public final OperationFuture<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();
 }
 

Parameter

Name	Description
name	String 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).

Returns

Type	Description
OperationFuture<Empty,DeleteTagBindingMetadata>

deleteTagBindingCallable()

public final UnaryCallable<DeleteTagBindingRequest,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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteTagBindingRequest,Operation>

deleteTagBindingOperationCallable()

public final OperationCallable<DeleteTagBindingRequest,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();
 }
 

Returns

Type	Description
OperationCallable<DeleteTagBindingRequest,Empty,DeleteTagBindingMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns

Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

getSettings()

public final TagBindingsSettings getSettings()

Returns

Type	Description
TagBindingsSettings

getStub()

public TagBindingsStub getStub()

Returns

Type	Description
TagBindingsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listTagBindings(ResourceName parent)

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(ResourceName parent)

Lists the TagBindings for the given 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);
   }
 }
 

Parameter

Name	Description
parent	com.google.api.resourcenames.ResourceName Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

Returns

Type	Description
TagBindingsClient.ListTagBindingsPagedResponse

listTagBindings(ListTagBindingsRequest request)

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(ListTagBindingsRequest request)

Lists the TagBindings for the given 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);
   }
 }
 

Parameter

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

Returns

Type	Description
TagBindingsClient.ListTagBindingsPagedResponse

listTagBindings(String parent)

public final TagBindingsClient.ListTagBindingsPagedResponse listTagBindings(String parent)

Lists the TagBindings for the given 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);
   }
 }
 

Parameter

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

Returns

Type	Description
TagBindingsClient.ListTagBindingsPagedResponse

listTagBindingsCallable()

public final UnaryCallable<ListTagBindingsRequest,ListTagBindingsResponse> listTagBindingsCallable()

Lists the TagBindings for the given 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTagBindingsRequest,ListTagBindingsResponse>

listTagBindingsPagedCallable()

public final UnaryCallable<ListTagBindingsRequest,TagBindingsClient.ListTagBindingsPagedResponse> listTagBindingsPagedCallable()

Lists the TagBindings for the given 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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTagBindingsRequest,ListTagBindingsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()