Class WorkloadIdentityClient (0.4.0)

GitHub RepositoryProduct Reference

Service Description: Service describing handlers for resources

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = workloadIdentityClient.getLocation(request);
 }
 

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

GenerateServiceAgents

Creates all service agents for a given resource, location and service producer.

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

  • generateServiceAgentsAsync(GenerateServiceAgentsRequest request)

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

  • generateServiceAgentsAsync(ServiceProducerName parent)

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

  • generateServiceAgentsOperationCallable()

  • generateServiceAgentsCallable()

ListLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

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 WorkloadIdentitySettings 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
 WorkloadIdentitySettings workloadIdentitySettings =
     WorkloadIdentitySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkloadIdentityClient workloadIdentityClient =
     WorkloadIdentityClient.create(workloadIdentitySettings);
 

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
 WorkloadIdentitySettings workloadIdentitySettings =
     WorkloadIdentitySettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkloadIdentityClient workloadIdentityClient =
     WorkloadIdentityClient.create(workloadIdentitySettings);
 

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
 WorkloadIdentitySettings workloadIdentitySettings =
     WorkloadIdentitySettings.newHttpJsonBuilder().build();
 WorkloadIdentityClient workloadIdentityClient =
     WorkloadIdentityClient.create(workloadIdentitySettings);
 

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

Inheritance

java.lang.Object > WorkloadIdentityClient

Static Methods

create()

public static final WorkloadIdentityClient create()

Constructs an instance of WorkloadIdentityClient with default settings.

Returns
Type Description
WorkloadIdentityClient
Exceptions
Type Description
IOException

create(WorkloadIdentitySettings settings)

public static final WorkloadIdentityClient create(WorkloadIdentitySettings settings)

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

create(WorkloadIdentityStub stub)

public static final WorkloadIdentityClient create(WorkloadIdentityStub stub)

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

Parameter
Name Description
stub WorkloadIdentityStub
Returns
Type Description
WorkloadIdentityClient

Constructors

WorkloadIdentityClient(WorkloadIdentitySettings settings)

protected WorkloadIdentityClient(WorkloadIdentitySettings settings)

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

WorkloadIdentityClient(WorkloadIdentityStub stub)

protected WorkloadIdentityClient(WorkloadIdentityStub stub)
Parameter
Name Description
stub WorkloadIdentityStub

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

generateServiceAgentsAsync(@Nullable ServiceProducerName parent)

public final OperationFuture<GenerateServiceAgentsResponse,OperationMetadata> generateServiceAgentsAsync(@Nullable ServiceProducerName parent)

Creates all service agents for a given resource, location and service producer.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   ServiceProducerName parent =
       ServiceProducerName.ofProjectLocationServiceProducerName(
           "[PROJECT]", "[LOCATION]", "[SERVICE_PRODUCER]");
   GenerateServiceAgentsResponse response =
       workloadIdentityClient.generateServiceAgentsAsync(parent).get();
 }
 
Parameter
Name Description
parent @org.jspecify.annotations.Nullable com.google.cloud.workloadidentity.v1.ServiceProducerName

Required. The parent resource. The location for the parent resource must be global.

Examples:

- projects/1234/locations/global/serviceProducers/bigquery.googleapis.com - folders/2344/locations/global/serviceProducers/vertexai.googleapis.com - organizations/3344/locations/global/serviceProducers/iam.googleapis.com

Returns
Type Description
OperationFuture<GenerateServiceAgentsResponse,OperationMetadata>

generateServiceAgentsAsync(GenerateServiceAgentsRequest request)

public final OperationFuture<GenerateServiceAgentsResponse,OperationMetadata> generateServiceAgentsAsync(GenerateServiceAgentsRequest request)

Creates all service agents for a given resource, location and service producer.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GenerateServiceAgentsRequest request =
       GenerateServiceAgentsRequest.newBuilder()
           .setParent(
               ServiceProducerName.ofProjectLocationServiceProducerName(
                       "[PROJECT]", "[LOCATION]", "[SERVICE_PRODUCER]")
                   .toString())
           .build();
   GenerateServiceAgentsResponse response =
       workloadIdentityClient.generateServiceAgentsAsync(request).get();
 }
 
Parameter
Name Description
request GenerateServiceAgentsRequest

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

Returns
Type Description
OperationFuture<GenerateServiceAgentsResponse,OperationMetadata>

generateServiceAgentsAsync(String parent)

public final OperationFuture<GenerateServiceAgentsResponse,OperationMetadata> generateServiceAgentsAsync(String parent)

Creates all service agents for a given resource, location and service producer.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   String parent =
       ServiceProducerName.ofProjectLocationServiceProducerName(
               "[PROJECT]", "[LOCATION]", "[SERVICE_PRODUCER]")
           .toString();
   GenerateServiceAgentsResponse response =
       workloadIdentityClient.generateServiceAgentsAsync(parent).get();
 }
 
Parameter
Name Description
parent String

Required. The parent resource. The location for the parent resource must be global.

Examples:

- projects/1234/locations/global/serviceProducers/bigquery.googleapis.com - folders/2344/locations/global/serviceProducers/vertexai.googleapis.com - organizations/3344/locations/global/serviceProducers/iam.googleapis.com

Returns
Type Description
OperationFuture<GenerateServiceAgentsResponse,OperationMetadata>

generateServiceAgentsCallable()

public final UnaryCallable<GenerateServiceAgentsRequest,Operation> generateServiceAgentsCallable()

Creates all service agents for a given resource, location and service producer.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GenerateServiceAgentsRequest request =
       GenerateServiceAgentsRequest.newBuilder()
           .setParent(
               ServiceProducerName.ofProjectLocationServiceProducerName(
                       "[PROJECT]", "[LOCATION]", "[SERVICE_PRODUCER]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       workloadIdentityClient.generateServiceAgentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GenerateServiceAgentsRequest,Operation>

generateServiceAgentsOperationCallable()

public final OperationCallable<GenerateServiceAgentsRequest,GenerateServiceAgentsResponse,OperationMetadata> generateServiceAgentsOperationCallable()

Creates all service agents for a given resource, location and service producer.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GenerateServiceAgentsRequest request =
       GenerateServiceAgentsRequest.newBuilder()
           .setParent(
               ServiceProducerName.ofProjectLocationServiceProducerName(
                       "[PROJECT]", "[LOCATION]", "[SERVICE_PRODUCER]")
                   .toString())
           .build();
   OperationFuture<GenerateServiceAgentsResponse, OperationMetadata> future =
       workloadIdentityClient.generateServiceAgentsOperationCallable().futureCall(request);
   // Do something.
   GenerateServiceAgentsResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<GenerateServiceAgentsRequest,GenerateServiceAgentsResponse,OperationMetadata>

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

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = workloadIdentityClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

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

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = workloadIdentityClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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 @Nullable WorkloadIdentitySettings getSettings()
Returns
Type Description
@org.jspecify.annotations.Nullable com.google.cloud.workloadidentity.v1.WorkloadIdentitySettings

getStub()

public WorkloadIdentityStub getStub()
Returns
Type Description
WorkloadIdentityStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final WorkloadIdentityClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : workloadIdentityClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

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

Returns
Type Description
WorkloadIdentityClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         workloadIdentityClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,WorkloadIdentityClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

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 (WorkloadIdentityClient workloadIdentityClient = WorkloadIdentityClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       workloadIdentityClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()