com.google.cloud.resourcemanager.v3

Class TagKeysClient

java.lang.Object

com.google.cloud.resourcemanager.v3.TagKeysClient

All Implemented Interfaces:

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

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

Service Description: Allow users to create and manage tag keys.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.getTagKey(name);
 }
 

Note: close() needs to be called on the TagKeysClient 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
ListTagKeys	Lists all TagKeys for a parent resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTagKeys(ListTagKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTagKeys(ResourceName parent) listTagKeys(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. listTagKeysPagedCallable() listTagKeysCallable()
GetTagKey	Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTagKey(GetTagKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTagKey(TagKeyName name) getTagKey(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. getTagKeyCallable()
GetNamespacedTagKey	Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNamespacedTagKey(GetNamespacedTagKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNamespacedTagKey(TagKeyName name) getNamespacedTagKey(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. getNamespacedTagKeyCallable()
CreateTagKey	Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTagKeyAsync(CreateTagKeyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createTagKeyAsync(TagKey tagKey) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTagKeyOperationCallable() createTagKeyCallable()
UpdateTagKey	Updates the attributes of the TagKey resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTagKeyAsync(UpdateTagKeyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateTagKeyAsync(TagKey tagKey, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTagKeyOperationCallable() updateTagKeyCallable()
DeleteTagKey	Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTagKeyAsync(DeleteTagKeyRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteTagKeyAsync(TagKeyName name) deleteTagKeyAsync(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. deleteTagKeyOperationCallable() deleteTagKeyCallable()
GetIamPolicy	Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(ResourceName resource) getIamPolicy(String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(ResourceName resource, Policy policy) setIamPolicy(String resource, Policy policy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". There are no permissions required for making this API call.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(ResourceName resource, List<String> permissions) testIamPermissions(String resource, List<String> permissions) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 TagKeysSettings 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
 TagKeysSettings tagKeysSettings =
     TagKeysSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);
 

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
 TagKeysSettings tagKeysSettings = TagKeysSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);
 

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
 TagKeysSettings tagKeysSettings = TagKeysSettings.newHttpJsonBuilder().build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);
 

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	TagKeysClient.ListTagKeysFixedSizeCollection
static class	TagKeysClient.ListTagKeysPage
static class	TagKeysClient.ListTagKeysPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TagKeysClient(TagKeysSettings settings) Constructs an instance of TagKeysClient, using the given settings.
protected	TagKeysClient(TagKeysStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TagKeysClient	create() Constructs an instance of TagKeysClient with default settings.
static TagKeysClient	create(TagKeysSettings settings) Constructs an instance of TagKeysClient, using the given settings.
static TagKeysClient	create(TagKeysStub stub) Constructs an instance of TagKeysClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<TagKey,CreateTagKeyMetadata>	createTagKeyAsync(CreateTagKeyRequest request) Creates a new TagKey.
com.google.api.gax.longrunning.OperationFuture<TagKey,CreateTagKeyMetadata>	createTagKeyAsync(TagKey tagKey) Creates a new TagKey.
com.google.api.gax.rpc.UnaryCallable<CreateTagKeyRequest,com.google.longrunning.Operation>	createTagKeyCallable() Creates a new TagKey.
com.google.api.gax.rpc.OperationCallable<CreateTagKeyRequest,TagKey,CreateTagKeyMetadata>	createTagKeyOperationCallable() Creates a new TagKey.
com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata>	deleteTagKeyAsync(DeleteTagKeyRequest request) Deletes a TagKey.
com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata>	deleteTagKeyAsync(String name) Deletes a TagKey.
com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata>	deleteTagKeyAsync(TagKeyName name) Deletes a TagKey.
com.google.api.gax.rpc.UnaryCallable<DeleteTagKeyRequest,com.google.longrunning.Operation>	deleteTagKeyCallable() Deletes a TagKey.
com.google.api.gax.rpc.OperationCallable<DeleteTagKeyRequest,TagKey,DeleteTagKeyMetadata>	deleteTagKeyOperationCallable() Deletes a TagKey.
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.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a TagKey.
com.google.iam.v1.Policy	getIamPolicy(com.google.api.resourcenames.ResourceName resource) Gets the access control policy for a TagKey.
com.google.iam.v1.Policy	getIamPolicy(String resource) Gets the access control policy for a TagKey.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the access control policy for a TagKey.
TagKey	getNamespacedTagKey(GetNamespacedTagKeyRequest request) Retrieves a TagKey by its namespaced name.
TagKey	getNamespacedTagKey(String name) Retrieves a TagKey by its namespaced name.
TagKey	getNamespacedTagKey(TagKeyName name) Retrieves a TagKey by its namespaced name.
com.google.api.gax.rpc.UnaryCallable<GetNamespacedTagKeyRequest,TagKey>	getNamespacedTagKeyCallable() Retrieves a TagKey by its namespaced name.
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.
TagKeysSettings	getSettings()
TagKeysStub	getStub()
TagKey	getTagKey(GetTagKeyRequest request) Retrieves a TagKey.
TagKey	getTagKey(String name) Retrieves a TagKey.
TagKey	getTagKey(TagKeyName name) Retrieves a TagKey.
com.google.api.gax.rpc.UnaryCallable<GetTagKeyRequest,TagKey>	getTagKeyCallable() Retrieves a TagKey.
boolean	isShutdown()
boolean	isTerminated()
TagKeysClient.ListTagKeysPagedResponse	listTagKeys(ListTagKeysRequest request) Lists all TagKeys for a parent resource.
TagKeysClient.ListTagKeysPagedResponse	listTagKeys(com.google.api.resourcenames.ResourceName parent) Lists all TagKeys for a parent resource.
TagKeysClient.ListTagKeysPagedResponse	listTagKeys(String parent) Lists all TagKeys for a parent resource.
com.google.api.gax.rpc.UnaryCallable<ListTagKeysRequest,ListTagKeysResponse>	listTagKeysCallable() Lists all TagKeys for a parent resource.
com.google.api.gax.rpc.UnaryCallable<ListTagKeysRequest,TagKeysClient.ListTagKeysPagedResponse>	listTagKeysPagedCallable() Lists all TagKeys for a parent resource.
com.google.iam.v1.Policy	setIamPolicy(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.Policy policy) Sets the access control policy on a TagKey, replacing any existing policy.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on a TagKey, replacing any existing policy.
com.google.iam.v1.Policy	setIamPolicy(String resource, com.google.iam.v1.Policy policy) Sets the access control policy on a TagKey, replacing any existing policy.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the access control policy on a TagKey, replacing any existing policy.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.api.resourcenames.ResourceName resource, List<String> permissions) Returns permissions that a caller has on the specified TagKey.
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(String resource, List<String> permissions) Returns permissions that a caller has on the specified TagKey.
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified TagKey.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns permissions that a caller has on the specified TagKey.
com.google.api.gax.longrunning.OperationFuture<TagKey,UpdateTagKeyMetadata>	updateTagKeyAsync(TagKey tagKey, com.google.protobuf.FieldMask updateMask) Updates the attributes of the TagKey resource.
com.google.api.gax.longrunning.OperationFuture<TagKey,UpdateTagKeyMetadata>	updateTagKeyAsync(UpdateTagKeyRequest request) Updates the attributes of the TagKey resource.
com.google.api.gax.rpc.UnaryCallable<UpdateTagKeyRequest,com.google.longrunning.Operation>	updateTagKeyCallable() Updates the attributes of the TagKey resource.
com.google.api.gax.rpc.OperationCallable<UpdateTagKeyRequest,TagKey,UpdateTagKeyMetadata>	updateTagKeyOperationCallable() Updates the attributes of the TagKey resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagKeysClient

protected TagKeysClient(TagKeysSettings settings)
                 throws IOException

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

TagKeysClient

protected TagKeysClient(TagKeysStub stub)

Method Detail

create

public static final TagKeysClient create()
                                  throws IOException

Constructs an instance of TagKeysClient with default settings.

Throws:

IOException

create

public static final TagKeysClient create(TagKeysSettings settings)
                                  throws IOException

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

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

getSettings

public final TagKeysSettings getSettings()

getStub

public TagKeysStub 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.

listTagKeys

public final TagKeysClient.ListTagKeysPagedResponse listTagKeys(com.google.api.resourcenames.ResourceName parent)

Lists all TagKeys for a parent 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagKey element : tagKeysClient.listTagKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`

Throws:

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

listTagKeys

public final TagKeysClient.ListTagKeysPagedResponse listTagKeys(String parent)

Lists all TagKeys for a parent 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String parent = FolderName.of("[FOLDER]").toString();
   for (TagKey element : tagKeysClient.listTagKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}`

Throws:

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

listTagKeys

public final TagKeysClient.ListTagKeysPagedResponse listTagKeys(ListTagKeysRequest request)

Lists all TagKeys for a parent 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ListTagKeysRequest request =
       ListTagKeysRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TagKey element : tagKeysClient.listTagKeys(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

listTagKeysPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagKeysRequest,TagKeysClient.ListTagKeysPagedResponse> listTagKeysPagedCallable()

Lists all TagKeys for a parent 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ListTagKeysRequest request =
       ListTagKeysRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TagKey> future = tagKeysClient.listTagKeysPagedCallable().futureCall(request);
   // Do something.
   for (TagKey element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTagKeysCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagKeysRequest,ListTagKeysResponse> listTagKeysCallable()

Lists all TagKeys for a parent 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ListTagKeysRequest request =
       ListTagKeysRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTagKeysResponse response = tagKeysClient.listTagKeysCallable().call(request);
     for (TagKey element : response.getTagKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getTagKey

public final TagKey getTagKey(TagKeyName name)

Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.getTagKey(name);
 }
 

Parameters:

name - Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.

Throws:

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

getTagKey

public final TagKey getTagKey(String name)

Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String name = TagKeyName.of("[TAG_KEY]").toString();
   TagKey response = tagKeysClient.getTagKey(name);
 }
 

Parameters:

name - Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.

Throws:

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

getTagKey

public final TagKey getTagKey(GetTagKeyRequest request)

Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetTagKeyRequest request =
       GetTagKeyRequest.newBuilder().setName(TagKeyName.of("[TAG_KEY]").toString()).build();
   TagKey response = tagKeysClient.getTagKey(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

getTagKeyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTagKeyRequest,TagKey> getTagKeyCallable()

Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetTagKeyRequest request =
       GetTagKeyRequest.newBuilder().setName(TagKeyName.of("[TAG_KEY]").toString()).build();
   ApiFuture<TagKey> future = tagKeysClient.getTagKeyCallable().futureCall(request);
   // Do something.
   TagKey response = future.get();
 }
 

getNamespacedTagKey

public final TagKey getNamespacedTagKey(TagKeyName name)

Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.getNamespacedTagKey(name);
 }
 

Parameters:

name - Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name "foo" under the organization with ID 42 or `r2-d2/bar` for a key with short name "bar" under the project `r2-d2`.

Throws:

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

getNamespacedTagKey

public final TagKey getNamespacedTagKey(String name)

Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String name = TagKeyName.of("[TAG_KEY]").toString();
   TagKey response = tagKeysClient.getNamespacedTagKey(name);
 }
 

Parameters:

name - Required. A namespaced tag key name in the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key with short name "foo" under the organization with ID 42 or `r2-d2/bar` for a key with short name "bar" under the project `r2-d2`.

Throws:

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

getNamespacedTagKey

public final TagKey getNamespacedTagKey(GetNamespacedTagKeyRequest request)

Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetNamespacedTagKeyRequest request =
       GetNamespacedTagKeyRequest.newBuilder()
           .setName(TagKeyName.of("[TAG_KEY]").toString())
           .build();
   TagKey response = tagKeysClient.getNamespacedTagKey(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

getNamespacedTagKeyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNamespacedTagKeyRequest,TagKey> getNamespacedTagKeyCallable()

Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetNamespacedTagKeyRequest request =
       GetNamespacedTagKeyRequest.newBuilder()
           .setName(TagKeyName.of("[TAG_KEY]").toString())
           .build();
   ApiFuture<TagKey> future = tagKeysClient.getNamespacedTagKeyCallable().futureCall(request);
   // Do something.
   TagKey response = future.get();
 }
 

createTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,CreateTagKeyMetadata> createTagKeyAsync(TagKey tagKey)

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKey tagKey = TagKey.newBuilder().build();
   TagKey response = tagKeysClient.createTagKeyAsync(tagKey).get();
 }
 

Parameters:

tagKey - Required. The TagKey to be created. Only fields `short_name`, `description`, and `parent` are considered during the creation request.

Throws:

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

createTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,CreateTagKeyMetadata> createTagKeyAsync(CreateTagKeyRequest request)

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   CreateTagKeyRequest request =
       CreateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setValidateOnly(true)
           .build();
   TagKey response = tagKeysClient.createTagKeyAsync(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

createTagKeyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateTagKeyRequest,TagKey,CreateTagKeyMetadata> createTagKeyOperationCallable()

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   CreateTagKeyRequest request =
       CreateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<TagKey, CreateTagKeyMetadata> future =
       tagKeysClient.createTagKeyOperationCallable().futureCall(request);
   // Do something.
   TagKey response = future.get();
 }
 

createTagKeyCallable

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

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   CreateTagKeyRequest request =
       CreateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = tagKeysClient.createTagKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

updateTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,UpdateTagKeyMetadata> updateTagKeyAsync(TagKey tagKey,
                                                                                                           com.google.protobuf.FieldMask updateMask)

Updates the attributes of the TagKey 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKey tagKey = TagKey.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TagKey response = tagKeysClient.updateTagKeyAsync(tagKey, updateMask).get();
 }
 

Parameters:

tagKey - Required. The new definition of the TagKey. Only the `description` and `etag` fields can be updated by this request. If the `etag` field is not empty, it must match the `etag` field of the existing tag key. Otherwise, `ABORTED` will be returned.

updateMask - Fields to be updated. The mask may only contain `description` or `etag`. If omitted entirely, both `description` and `etag` are assumed to be significant.

Throws:

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

updateTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,UpdateTagKeyMetadata> updateTagKeyAsync(UpdateTagKeyRequest request)

Updates the attributes of the TagKey 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   UpdateTagKeyRequest request =
       UpdateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   TagKey response = tagKeysClient.updateTagKeyAsync(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

updateTagKeyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateTagKeyRequest,TagKey,UpdateTagKeyMetadata> updateTagKeyOperationCallable()

Updates the attributes of the TagKey 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   UpdateTagKeyRequest request =
       UpdateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<TagKey, UpdateTagKeyMetadata> future =
       tagKeysClient.updateTagKeyOperationCallable().futureCall(request);
   // Do something.
   TagKey response = future.get();
 }
 

updateTagKeyCallable

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

Updates the attributes of the TagKey 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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   UpdateTagKeyRequest request =
       UpdateTagKeyRequest.newBuilder()
           .setTagKey(TagKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = tagKeysClient.updateTagKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata> deleteTagKeyAsync(TagKeyName name)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.deleteTagKeyAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.

Throws:

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

deleteTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata> deleteTagKeyAsync(String name)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String name = TagKeyName.of("[TAG_KEY]").toString();
   TagKey response = tagKeysClient.deleteTagKeyAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.

Throws:

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

deleteTagKeyAsync

public final com.google.api.gax.longrunning.OperationFuture<TagKey,DeleteTagKeyMetadata> deleteTagKeyAsync(DeleteTagKeyRequest request)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   DeleteTagKeyRequest request =
       DeleteTagKeyRequest.newBuilder()
           .setName(TagKeyName.of("[TAG_KEY]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   TagKey response = tagKeysClient.deleteTagKeyAsync(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

deleteTagKeyOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteTagKeyRequest,TagKey,DeleteTagKeyMetadata> deleteTagKeyOperationCallable()

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   DeleteTagKeyRequest request =
       DeleteTagKeyRequest.newBuilder()
           .setName(TagKeyName.of("[TAG_KEY]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<TagKey, DeleteTagKeyMetadata> future =
       tagKeysClient.deleteTagKeyOperationCallable().futureCall(request);
   // Do something.
   TagKey response = future.get();
 }
 

deleteTagKeyCallable

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

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   DeleteTagKeyRequest request =
       DeleteTagKeyRequest.newBuilder()
           .setName(TagKeyName.of("[TAG_KEY]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = tagKeysClient.deleteTagKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName resource)

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ResourceName resource = TagKeyName.of("[TAG_KEY]");
   Policy response = tagKeysClient.getIamPolicy(resource);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Throws:

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

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(String resource)

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy response = tagKeysClient.getIamPolicy(resource);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Throws:

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

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = tagKeysClient.getIamPolicy(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

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = tagKeysClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource,
                                                   com.google.iam.v1.Policy policy)

Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ResourceName resource = TagKeyName.of("[TAG_KEY]");
   Policy policy = Policy.newBuilder().build();
   Policy response = tagKeysClient.setIamPolicy(resource, policy);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Throws:

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

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(String resource,
                                                   com.google.iam.v1.Policy policy)

Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = tagKeysClient.setIamPolicy(resource, policy);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Throws:

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

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = tagKeysClient.setIamPolicy(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

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = tagKeysClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.ResourceName resource,
                                                                             List<String> permissions)

Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   ResourceName resource = TagKeyName.of("[TAG_KEY]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response = tagKeysClient.testIamPermissions(resource, permissions);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Throws:

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

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource,
                                                                             List<String> permissions)

Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response = tagKeysClient.testIamPermissions(resource, permissions);
 }
 

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Throws:

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

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = tagKeysClient.testIamPermissions(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

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(TagKeyName.of("[TAG_KEY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       tagKeysClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse 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