Class TagValuesClient (1.45.0)

GitHub RepositoryProduct Reference

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

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.getTagValue(name);
 }

Note: close() needs to be called on the TagValuesClient 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

ListTagValues

Lists all TagValues for a specific TagKey.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTagValues(ListTagValuesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTagValues(ResourceName parent)

  • listTagValues(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.

  • listTagValuesPagedCallable()

  • listTagValuesCallable()

GetTagValue

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value 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.

  • getTagValue(GetTagValueRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTagValue(TagValueName name)

  • getTagValue(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.

  • getTagValueCallable()

GetNamespacedTagValue

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value 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.

  • getNamespacedTagValue(GetNamespacedTagValueRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNamespacedTagValue(TagValueName name)

  • getNamespacedTagValue(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.

  • getNamespacedTagValueCallable()

CreateTagValue

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey at any given time.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createTagValueAsync(CreateTagValueRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createTagValueAsync(TagValue tagValue)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createTagValueOperationCallable()

  • createTagValueCallable()

UpdateTagValue

Updates the attributes of the TagValue resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTagValueAsync(UpdateTagValueRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateTagValueAsync(TagValue tagValue, 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.

  • updateTagValueOperationCallable()

  • updateTagValueCallable()

DeleteTagValue

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteTagValueAsync(DeleteTagValueRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteTagValueAsync(TagValueName name)

  • deleteTagValueAsync(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.

  • deleteTagValueOperationCallable()

  • deleteTagValueCallable()

GetIamPolicy

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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 TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 TagValuesSettings 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
 TagValuesSettings tagValuesSettings =
     TagValuesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

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
 TagValuesSettings tagValuesSettings =
     TagValuesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

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
 TagValuesSettings tagValuesSettings = TagValuesSettings.newHttpJsonBuilder().build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

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

Inheritance

java.lang.Object > TagValuesClient

Static Methods

create()

public static final TagValuesClient create()

Constructs an instance of TagValuesClient with default settings.

Returns
Type Description
TagValuesClient
Exceptions
Type Description
IOException

create(TagValuesSettings settings)

public static final TagValuesClient create(TagValuesSettings settings)

Constructs an instance of TagValuesClient, 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 TagValuesSettings
Returns
Type Description
TagValuesClient
Exceptions
Type Description
IOException

create(TagValuesStub stub)

public static final TagValuesClient create(TagValuesStub stub)

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

Parameter
Name Description
stub TagValuesStub
Returns
Type Description
TagValuesClient

Constructors

TagValuesClient(TagValuesSettings settings)

protected TagValuesClient(TagValuesSettings settings)

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

TagValuesClient(TagValuesStub stub)

protected TagValuesClient(TagValuesStub stub)
Parameter
Name Description
stub TagValuesStub

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

createTagValueAsync(CreateTagValueRequest request)

public final OperationFuture<TagValue,CreateTagValueMetadata> createTagValueAsync(CreateTagValueRequest request)

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   CreateTagValueRequest request =
       CreateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setValidateOnly(true)
           .build();
   TagValue response = tagValuesClient.createTagValueAsync(request).get();
 }
Parameter
Name Description
request CreateTagValueRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<TagValue,CreateTagValueMetadata>

createTagValueAsync(TagValue tagValue)

public final OperationFuture<TagValue,CreateTagValueMetadata> createTagValueAsync(TagValue tagValue)

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValue tagValue = TagValue.newBuilder().build();
   TagValue response = tagValuesClient.createTagValueAsync(tagValue).get();
 }
Parameter
Name Description
tagValue TagValue

Required. The TagValue to be created. Only fields short_name, description, and parent are considered during the creation request.
Returns
Type Description
OperationFuture<TagValue,CreateTagValueMetadata>

createTagValueCallable()

public final UnaryCallable<CreateTagValueRequest,Operation> createTagValueCallable()

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   CreateTagValueRequest request =
       CreateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = tagValuesClient.createTagValueCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateTagValueRequest,Operation>

createTagValueOperationCallable()

public final OperationCallable<CreateTagValueRequest,TagValue,CreateTagValueMetadata> createTagValueOperationCallable()

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   CreateTagValueRequest request =
       CreateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<TagValue, CreateTagValueMetadata> future =
       tagValuesClient.createTagValueOperationCallable().futureCall(request);
   // Do something.
   TagValue response = future.get();
 }
Returns
Type Description
OperationCallable<CreateTagValueRequest,TagValue,CreateTagValueMetadata>

deleteTagValueAsync(DeleteTagValueRequest request)

public final OperationFuture<TagValue,DeleteTagValueMetadata> deleteTagValueAsync(DeleteTagValueRequest request)

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   DeleteTagValueRequest request =
       DeleteTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   TagValue response = tagValuesClient.deleteTagValueAsync(request).get();
 }
Parameter
Name Description
request DeleteTagValueRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<TagValue,DeleteTagValueMetadata>

deleteTagValueAsync(TagValueName name)

public final OperationFuture<TagValue,DeleteTagValueMetadata> deleteTagValueAsync(TagValueName name)

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.deleteTagValueAsync(name).get();
 }
Parameter
Name Description
name TagValueName

Required. Resource name for TagValue to be deleted in the format tagValues/456.
Returns
Type Description
OperationFuture<TagValue,DeleteTagValueMetadata>

deleteTagValueAsync(String name)

public final OperationFuture<TagValue,DeleteTagValueMetadata> deleteTagValueAsync(String name)

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String name = TagValueName.of("[TAG_VALUE]").toString();
   TagValue response = tagValuesClient.deleteTagValueAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name for TagValue to be deleted in the format tagValues/456.
Returns
Type Description
OperationFuture<TagValue,DeleteTagValueMetadata>

deleteTagValueCallable()

public final UnaryCallable<DeleteTagValueRequest,Operation> deleteTagValueCallable()

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   DeleteTagValueRequest request =
       DeleteTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = tagValuesClient.deleteTagValueCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteTagValueRequest,Operation>

deleteTagValueOperationCallable()

public final OperationCallable<DeleteTagValueRequest,TagValue,DeleteTagValueMetadata> deleteTagValueOperationCallable()

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   DeleteTagValueRequest request =
       DeleteTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<TagValue, DeleteTagValueMetadata> future =
       tagValuesClient.deleteTagValueOperationCallable().futureCall(request);
   // Do something.
   TagValue response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteTagValueRequest,TagValue,DeleteTagValueMetadata>

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 TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ResourceName resource = TagValueName.of("[TAG_VALUE]");
   Policy response = tagValuesClient.getIamPolicy(resource);
 }
Parameter
Name Description
resource com.google.api.resourcenames.ResourceName

REQUIRED: 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 TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = tagValuesClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The 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 TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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

REQUIRED: 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 TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = tagValuesClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getNamespacedTagValue(GetNamespacedTagValueRequest request)

public final TagValue getNamespacedTagValue(GetNamespacedTagValueRequest request)

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetNamespacedTagValueRequest request =
       GetNamespacedTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .build();
   TagValue response = tagValuesClient.getNamespacedTagValue(request);
 }
Parameter
Name Description
request GetNamespacedTagValueRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TagValue

getNamespacedTagValue(TagValueName name)

public final TagValue getNamespacedTagValue(TagValueName name)

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.getNamespacedTagValue(name);
 }
Parameter
Name Description
name TagValueName

Required. A namespaced tag value name in the following format:

{parentId}/{tagKeyShort}/{tagValueShort}

Examples: - 42/foo/abc for a value with short name "abc" under the key with short name "foo" under the organization with ID 42 - r2-d2/bar/xyz for a value with short name "xyz" under the key with short name "bar" under the project with ID "r2-d2"
Returns
Type Description
TagValue

getNamespacedTagValue(String name)

public final TagValue getNamespacedTagValue(String name)

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String name = TagValueName.of("[TAG_VALUE]").toString();
   TagValue response = tagValuesClient.getNamespacedTagValue(name);
 }
Parameter
Name Description
name String

Required. A namespaced tag value name in the following format:

{parentId}/{tagKeyShort}/{tagValueShort}

Examples: - 42/foo/abc for a value with short name "abc" under the key with short name "foo" under the organization with ID 42 - r2-d2/bar/xyz for a value with short name "xyz" under the key with short name "bar" under the project with ID "r2-d2"
Returns
Type Description
TagValue

getNamespacedTagValueCallable()

public final UnaryCallable<GetNamespacedTagValueRequest,TagValue> getNamespacedTagValueCallable()

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetNamespacedTagValueRequest request =
       GetNamespacedTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .build();
   ApiFuture<TagValue> future =
       tagValuesClient.getNamespacedTagValueCallable().futureCall(request);
   // Do something.
   TagValue response = future.get();
 }
Returns
Type Description
UnaryCallable<GetNamespacedTagValueRequest,TagValue>

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 TagValuesSettings getSettings()
Returns
Type Description
TagValuesSettings

getStub()

public TagValuesStub getStub()
Returns
Type Description
TagValuesStub

getTagValue(GetTagValueRequest request)

public final TagValue getTagValue(GetTagValueRequest request)

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetTagValueRequest request =
       GetTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .build();
   TagValue response = tagValuesClient.getTagValue(request);
 }
Parameter
Name Description
request GetTagValueRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TagValue

getTagValue(TagValueName name)

public final TagValue getTagValue(TagValueName name)

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.getTagValue(name);
 }
Parameter
Name Description
name TagValueName

Required. Resource name for TagValue to be fetched in the format tagValues/456.
Returns
Type Description
TagValue

getTagValue(String name)

public final TagValue getTagValue(String name)

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String name = TagValueName.of("[TAG_VALUE]").toString();
   TagValue response = tagValuesClient.getTagValue(name);
 }
Parameter
Name Description
name String

Required. Resource name for TagValue to be fetched in the format tagValues/456.
Returns
Type Description
TagValue

getTagValueCallable()

public final UnaryCallable<GetTagValueRequest,TagValue> getTagValueCallable()

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   GetTagValueRequest request =
       GetTagValueRequest.newBuilder()
           .setName(TagValueName.of("[TAG_VALUE]").toString())
           .build();
   ApiFuture<TagValue> future = tagValuesClient.getTagValueCallable().futureCall(request);
   // Do something.
   TagValue response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTagValueRequest,TagValue>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listTagValues(ResourceName parent)

public final TagValuesClient.ListTagValuesPagedResponse listTagValues(ResourceName parent)

Lists all TagValues for a specific 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagValue element : tagValuesClient.listTagValues(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent com.google.api.resourcenames.ResourceName

Required.
Returns
Type Description
TagValuesClient.ListTagValuesPagedResponse

listTagValues(ListTagValuesRequest request)

public final TagValuesClient.ListTagValuesPagedResponse listTagValues(ListTagValuesRequest request)

Lists all TagValues for a specific 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ListTagValuesRequest request =
       ListTagValuesRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TagValue element : tagValuesClient.listTagValues(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListTagValuesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TagValuesClient.ListTagValuesPagedResponse

listTagValues(String parent)

public final TagValuesClient.ListTagValuesPagedResponse listTagValues(String parent)

Lists all TagValues for a specific 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String parent = FolderName.of("[FOLDER]").toString();
   for (TagValue element : tagValuesClient.listTagValues(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required.
Returns
Type Description
TagValuesClient.ListTagValuesPagedResponse

listTagValuesCallable()

public final UnaryCallable<ListTagValuesRequest,ListTagValuesResponse> listTagValuesCallable()

Lists all TagValues for a specific 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ListTagValuesRequest request =
       ListTagValuesRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTagValuesResponse response = tagValuesClient.listTagValuesCallable().call(request);
     for (TagValue element : response.getTagValuesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListTagValuesRequest,ListTagValuesResponse>

listTagValuesPagedCallable()

public final UnaryCallable<ListTagValuesRequest,TagValuesClient.ListTagValuesPagedResponse> listTagValuesPagedCallable()

Lists all TagValues for a specific 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ListTagValuesRequest request =
       ListTagValuesRequest.newBuilder()
           .setParent(FolderName.of("[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TagValue> future = tagValuesClient.listTagValuesPagedCallable().futureCall(request);
   // Do something.
   for (TagValue element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTagValuesRequest,ListTagValuesPagedResponse>

setIamPolicy(ResourceName resource, Policy policy)

public final Policy setIamPolicy(ResourceName resource, Policy policy)

Sets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ResourceName resource = TagValueName.of("[TAG_VALUE]");
   Policy policy = Policy.newBuilder().build();
   Policy response = tagValuesClient.setIamPolicy(resource, policy);
 }
Parameters
Name Description
resource com.google.api.resourcenames.ResourceName

REQUIRED: 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.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.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = tagValuesClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The 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 TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   Policy policy = Policy.newBuilder().build();
   Policy response = tagValuesClient.setIamPolicy(resource, policy);
 }
Parameters
Name Description
resource String

REQUIRED: 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.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.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = tagValuesClient.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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   ResourceName resource = TagValueName.of("[TAG_VALUE]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       tagValuesClient.testIamPermissions(resource, permissions);
 }
Parameters
Name Description
resource com.google.api.resourcenames.ResourceName

REQUIRED: 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 resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = tagValuesClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The 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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   String resource = FolderName.of("[FOLDER]").toString();
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response =
       tagValuesClient.testIamPermissions(resource, permissions);
 }
Parameters
Name Description
resource String

REQUIRED: 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 resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(TagValueName.of("[TAG_VALUE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       tagValuesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateTagValueAsync(TagValue tagValue, FieldMask updateMask)

public final OperationFuture<TagValue,UpdateTagValueMetadata> updateTagValueAsync(TagValue tagValue, FieldMask updateMask)

Updates the attributes of the TagValue 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValue tagValue = TagValue.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TagValue response = tagValuesClient.updateTagValueAsync(tagValue, updateMask).get();
 }
Parameters
Name Description
tagValue TagValue

Required. The new definition of the TagValue. Only fields description and etag fields can be updated by this request. If the etag field is nonempty, it must match the etag field of the existing ControlGroup. Otherwise, ABORTED will be returned.
updateMask FieldMask

Optional. Fields to be updated.
Returns
Type Description
OperationFuture<TagValue,UpdateTagValueMetadata>

updateTagValueAsync(UpdateTagValueRequest request)

public final OperationFuture<TagValue,UpdateTagValueMetadata> updateTagValueAsync(UpdateTagValueRequest request)

Updates the attributes of the TagValue 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   UpdateTagValueRequest request =
       UpdateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   TagValue response = tagValuesClient.updateTagValueAsync(request).get();
 }
Parameter
Name Description
request UpdateTagValueRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<TagValue,UpdateTagValueMetadata>

updateTagValueCallable()

public final UnaryCallable<UpdateTagValueRequest,Operation> updateTagValueCallable()

Updates the attributes of the TagValue 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   UpdateTagValueRequest request =
       UpdateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = tagValuesClient.updateTagValueCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateTagValueRequest,Operation>

updateTagValueOperationCallable()

public final OperationCallable<UpdateTagValueRequest,TagValue,UpdateTagValueMetadata> updateTagValueOperationCallable()

Updates the attributes of the TagValue 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   UpdateTagValueRequest request =
       UpdateTagValueRequest.newBuilder()
           .setTagValue(TagValue.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<TagValue, UpdateTagValueMetadata> future =
       tagValuesClient.updateTagValueOperationCallable().futureCall(request);
   // Do something.
   TagValue response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateTagValueRequest,TagValue,UpdateTagValueMetadata>