- 1.78.0 (latest)
- 1.77.0
- 1.76.0
- 1.75.0
- 1.74.0
- 1.72.0
- 1.70.0
- 1.69.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 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
| GitHub Repository | Product Reference |
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTagKey |
Retrieves a TagKey. This method will return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetNamespacedTagKey |
Retrieves a TagKey by its namespaced name. This method will return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on a TagKey, replacing any existing policy. The |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Returns permissions that a caller has on the specified TagKey. The 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
Static Methods
create()
public static final TagKeysClient create()Constructs an instance of TagKeysClient with default settings.
| Returns | |
|---|---|
| Type | Description |
TagKeysClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(TagKeysSettings settings)
public static final TagKeysClient create(TagKeysSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
TagKeysSettings |
| Returns | |
|---|---|
| Type | Description |
TagKeysClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(TagKeysStub stub)
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).
| Parameter | |
|---|---|
| Name | Description |
stub |
TagKeysStub |
| Returns | |
|---|---|
| Type | Description |
TagKeysClient |
|
Constructors
TagKeysClient(TagKeysSettings settings)
protected TagKeysClient(TagKeysSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
TagKeysSettings |
TagKeysClient(TagKeysStub stub)
protected TagKeysClient(TagKeysStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
TagKeysStub |
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()createTagKeyAsync(CreateTagKeyRequest request)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateTagKeyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,CreateTagKeyMetadata> |
|
createTagKeyAsync(TagKey tagKey)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
tagKey |
TagKeyRequired. The TagKey to be created. Only fields |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,CreateTagKeyMetadata> |
|
createTagKeyCallable()
public final UnaryCallable<CreateTagKeyRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateTagKeyRequest,Operation> |
|
createTagKeyOperationCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateTagKeyRequest,TagKey,CreateTagKeyMetadata> |
|
deleteTagKeyAsync(DeleteTagKeyRequest request)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteTagKeyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,DeleteTagKeyMetadata> |
|
deleteTagKeyAsync(TagKeyName name)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
name |
TagKeyNameRequired. The resource name of a TagKey to be deleted in the format |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,DeleteTagKeyMetadata> |
|
deleteTagKeyAsync(String name)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The resource name of a TagKey to be deleted in the format |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,DeleteTagKeyMetadata> |
|
deleteTagKeyCallable()
public final UnaryCallable<DeleteTagKeyRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteTagKeyRequest,Operation> |
|
deleteTagKeyOperationCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteTagKeyRequest,TagKey,DeleteTagKeyMetadata> |
|
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 |
|
getIamPolicy(ResourceName resource)
public final Policy getIamPolicy(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);
}
| Parameter | |
|---|---|
| Name | Description |
resource |
com.google.api.resourcenames.ResourceNameREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicy(String resource)
public final 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);
}
| Parameter | |
|---|---|
| Name | Description |
resource |
StringREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getNamespacedTagKey(GetNamespacedTagKeyRequest request)
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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetNamespacedTagKeyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getNamespacedTagKey(TagKeyName name)
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);
}
| Parameter | |
|---|---|
| Name | Description |
name |
TagKeyNameRequired. A namespaced tag key name in the format |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getNamespacedTagKey(String name)
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);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. A namespaced tag key name in the format |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getNamespacedTagKeyCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetNamespacedTagKeyRequest,TagKey> |
|
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 TagKeysSettings getSettings()| Returns | |
|---|---|
| Type | Description |
TagKeysSettings |
|
getStub()
public TagKeysStub getStub()| Returns | |
|---|---|
| Type | Description |
TagKeysStub |
|
getTagKey(GetTagKeyRequest request)
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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetTagKeyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getTagKey(TagKeyName name)
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);
}
| Parameter | |
|---|---|
| Name | Description |
name |
TagKeyNameRequired. A resource name in the format |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getTagKey(String name)
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);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. A resource name in the format |
| Returns | |
|---|---|
| Type | Description |
TagKey |
|
getTagKeyCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetTagKeyRequest,TagKey> |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listTagKeys(ResourceName parent)
public final TagKeysClient.ListTagKeysPagedResponse listTagKeys(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);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
com.google.api.resourcenames.ResourceNameRequired. The resource name of the TagKey's parent. Must be of the form
|
| Returns | |
|---|---|
| Type | Description |
TagKeysClient.ListTagKeysPagedResponse |
|
listTagKeys(ListTagKeysRequest request)
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListTagKeysRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TagKeysClient.ListTagKeysPagedResponse |
|
listTagKeys(String parent)
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The resource name of the TagKey's parent. Must be of the form
|
| Returns | |
|---|---|
| Type | Description |
TagKeysClient.ListTagKeysPagedResponse |
|
listTagKeysCallable()
public final 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;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTagKeysRequest,ListTagKeysResponse> |
|
listTagKeysPagedCallable()
public final 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);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTagKeysRequest,ListTagKeysPagedResponse> |
|
setIamPolicy(ResourceName resource, Policy policy)
public final Policy setIamPolicy(ResourceName resource, 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 | |
|---|---|
| Name | Description |
resource |
com.google.api.resourcenames.ResourceNameREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
com.google.iam.v1.PolicyREQUIRED: The complete policy to be applied to the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicy(String resource, Policy policy)
public final Policy setIamPolicy(String resource, 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 | |
|---|---|
| Name | Description |
resource |
StringREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
com.google.iam.v1.PolicyREQUIRED: The complete policy to be applied to the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()testIamPermissions(ResourceName resource, List<String> permissions)
public final TestIamPermissionsResponse testIamPermissions(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 | |
|---|---|
| Name | Description |
resource |
com.google.api.resourcenames.ResourceNameREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
List<String>The set of permissions to check for the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(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);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
testIamPermissions(String resource, List<String> permissions)
public final 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 | |
|---|---|
| Name | Description |
resource |
StringREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
List<String>The set of permissions to check for the |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|
updateTagKeyAsync(TagKey tagKey, FieldMask updateMask)
public final OperationFuture<TagKey,UpdateTagKeyMetadata> updateTagKeyAsync(TagKey tagKey, 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 | |
|---|---|
| Name | Description |
tagKey |
TagKeyRequired. The new definition of the TagKey. Only the |
updateMask |
FieldMaskFields to be updated. The mask may only contain |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,UpdateTagKeyMetadata> |
|
updateTagKeyAsync(UpdateTagKeyRequest request)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateTagKeyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<TagKey,UpdateTagKeyMetadata> |
|
updateTagKeyCallable()
public final UnaryCallable<UpdateTagKeyRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateTagKeyRequest,Operation> |
|
updateTagKeyOperationCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<UpdateTagKeyRequest,TagKey,UpdateTagKeyMetadata> |
|