TagValuesClient (Google Cloud Resource Manager 1.69.0 API)

java.lang.Object
- com.google.cloud.resourcemanager.v3.TagValuesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

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

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TagValuesClient.ListTagValuesFixedSizeCollection`
`static class`	`TagValuesClient.ListTagValuesPage`
`static class`	`TagValuesClient.ListTagValuesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TagValuesClient(TagValuesSettings settings)` Constructs an instance of TagValuesClient, using the given settings.
`protected`	`TagValuesClient(TagValuesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static TagValuesClient`	`create()` Constructs an instance of TagValuesClient with default settings.
`static TagValuesClient`	`create(TagValuesSettings settings)` Constructs an instance of TagValuesClient, using the given settings.
`static TagValuesClient`	`create(TagValuesStub stub)` Constructs an instance of TagValuesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<TagValue,CreateTagValueMetadata>`	`createTagValueAsync(CreateTagValueRequest request)` Creates a TagValue as a child of the specified TagKey.
`com.google.api.gax.longrunning.OperationFuture<TagValue,CreateTagValueMetadata>`	`createTagValueAsync(TagValue tagValue)` Creates a TagValue as a child of the specified TagKey.
`com.google.api.gax.rpc.UnaryCallable<CreateTagValueRequest,com.google.longrunning.Operation>`	`createTagValueCallable()` Creates a TagValue as a child of the specified TagKey.
`com.google.api.gax.rpc.OperationCallable<CreateTagValueRequest,TagValue,CreateTagValueMetadata>`	`createTagValueOperationCallable()` Creates a TagValue as a child of the specified TagKey.
`com.google.api.gax.longrunning.OperationFuture<TagValue,DeleteTagValueMetadata>`	`deleteTagValueAsync(DeleteTagValueRequest request)` Deletes a TagValue.
`com.google.api.gax.longrunning.OperationFuture<TagValue,DeleteTagValueMetadata>`	`deleteTagValueAsync(String name)` Deletes a TagValue.
`com.google.api.gax.longrunning.OperationFuture<TagValue,DeleteTagValueMetadata>`	`deleteTagValueAsync(TagValueName name)` Deletes a TagValue.
`com.google.api.gax.rpc.UnaryCallable<DeleteTagValueRequest,com.google.longrunning.Operation>`	`deleteTagValueCallable()` Deletes a TagValue.
`com.google.api.gax.rpc.OperationCallable<DeleteTagValueRequest,TagValue,DeleteTagValueMetadata>`	`deleteTagValueOperationCallable()` Deletes a TagValue.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a TagValue.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.api.resourcenames.ResourceName resource)` Gets the access control policy for a TagValue.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for a TagValue.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a TagValue.
`TagValue`	`getNamespacedTagValue(GetNamespacedTagValueRequest request)` Retrieves a TagValue by its namespaced name.
`TagValue`	`getNamespacedTagValue(String name)` Retrieves a TagValue by its namespaced name.
`TagValue`	`getNamespacedTagValue(TagValueName name)` Retrieves a TagValue by its namespaced name.
`com.google.api.gax.rpc.UnaryCallable<GetNamespacedTagValueRequest,TagValue>`	`getNamespacedTagValueCallable()` Retrieves a TagValue by its namespaced name.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`TagValuesSettings`	`getSettings()`
`TagValuesStub`	`getStub()`
`TagValue`	`getTagValue(GetTagValueRequest request)` Retrieves a TagValue.
`TagValue`	`getTagValue(String name)` Retrieves a TagValue.
`TagValue`	`getTagValue(TagValueName name)` Retrieves a TagValue.
`com.google.api.gax.rpc.UnaryCallable<GetTagValueRequest,TagValue>`	`getTagValueCallable()` Retrieves a TagValue.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TagValuesClient.ListTagValuesPagedResponse`	`listTagValues(ListTagValuesRequest request)` Lists all TagValues for a specific TagKey.
`TagValuesClient.ListTagValuesPagedResponse`	`listTagValues(com.google.api.resourcenames.ResourceName parent)` Lists all TagValues for a specific TagKey.
`TagValuesClient.ListTagValuesPagedResponse`	`listTagValues(String parent)` Lists all TagValues for a specific TagKey.
`com.google.api.gax.rpc.UnaryCallable<ListTagValuesRequest,ListTagValuesResponse>`	`listTagValuesCallable()` Lists all TagValues for a specific TagKey.
`com.google.api.gax.rpc.UnaryCallable<ListTagValuesRequest,TagValuesClient.ListTagValuesPagedResponse>`	`listTagValuesPagedCallable()` Lists all TagValues for a specific TagKey.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.Policy policy)` Sets the access control policy on a TagValue, replacing any existing policy.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on a TagValue, replacing any existing policy.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource, com.google.iam.v1.Policy policy)` Sets the access control policy on a TagValue, replacing any existing policy.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on a TagValue, replacing any existing policy.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.api.resourcenames.ResourceName resource, List<String> permissions)` Returns permissions that a caller has on the specified TagValue.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns permissions that a caller has on the specified TagValue.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified TagValue.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified TagValue.
`com.google.api.gax.longrunning.OperationFuture<TagValue,UpdateTagValueMetadata>`	`updateTagValueAsync(TagValue tagValue, com.google.protobuf.FieldMask updateMask)` Updates the attributes of the TagValue resource.
`com.google.api.gax.longrunning.OperationFuture<TagValue,UpdateTagValueMetadata>`	`updateTagValueAsync(UpdateTagValueRequest request)` Updates the attributes of the TagValue resource.
`com.google.api.gax.rpc.UnaryCallable<UpdateTagValueRequest,com.google.longrunning.Operation>`	`updateTagValueCallable()` Updates the attributes of the TagValue resource.
`com.google.api.gax.rpc.OperationCallable<UpdateTagValueRequest,TagValue,UpdateTagValueMetadata>`	`updateTagValueOperationCallable()` Updates the attributes of the TagValue resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TagValuesClient
```
protected TagValuesClient(TagValuesSettings settings)
                   throws IOException
```
  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.
  
  Throws:
  
  IOException
- TagValuesClient
```
protected TagValuesClient(TagValuesStub stub)
```

Method Detail

create

public static final TagValuesClient create()
                                    throws IOException

Constructs an instance of TagValuesClient with default settings.

Throws:: IOException

create
```
public static final TagValuesClient create(TagValuesSettings settings)
                                    throws IOException
```
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.

Throws:

IOException

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

getSettings

public final TagValuesSettings getSettings()

getStub
```
public TagValuesStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.