Class TasksClient (0.46.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Cloud Run Task Control Plane API.

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 (TasksClient tasksClient = TasksClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]");
   Task response = tasksClient.getTask(name);
 }

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

GetTask

Gets information about a Task.

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

  • getTask(GetTaskRequest request)

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

  • getTask(TaskName name)

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

  • getTaskCallable()

ListTasks

Lists Tasks from an Execution of a Job.

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

  • listTasks(ListTasksRequest request)

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

  • listTasks(ExecutionName parent)

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

  • listTasksPagedCallable()

  • listTasksCallable()

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 TasksSettings 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
 TasksSettings tasksSettings =
     TasksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

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
 TasksSettings tasksSettings = TasksSettings.newBuilder().setEndpoint(myEndpoint).build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

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
 TasksSettings tasksSettings = TasksSettings.newHttpJsonBuilder().build();
 TasksClient tasksClient = TasksClient.create(tasksSettings);

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

Inheritance

java.lang.Object > TasksClient

Static Methods

create()

public static final TasksClient create()

Constructs an instance of TasksClient with default settings.

Returns
Type Description
TasksClient
Exceptions
Type Description
IOException

create(TasksSettings settings)

public static final TasksClient create(TasksSettings settings)

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

create(TasksStub stub)

public static final TasksClient create(TasksStub stub)

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

Parameter
Name Description
stub TasksStub
Returns
Type Description
TasksClient

Constructors

TasksClient(TasksSettings settings)

protected TasksClient(TasksSettings settings)

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

TasksClient(TasksStub stub)

protected TasksClient(TasksStub stub)
Parameter
Name Description
stub TasksStub

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

getSettings()

public final TasksSettings getSettings()
Returns
Type Description
TasksSettings

getStub()

public TasksStub getStub()
Returns
Type Description
TasksStub

getTask(GetTaskRequest request)

public final Task getTask(GetTaskRequest request)

Gets information about a Task.

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 (TasksClient tasksClient = TasksClient.create()) {
   GetTaskRequest request =
       GetTaskRequest.newBuilder()
           .setName(
               TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]")
                   .toString())
           .build();
   Task response = tasksClient.getTask(request);
 }
Parameter
Name Description
request GetTaskRequest

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

getTask(TaskName name)

public final Task getTask(TaskName name)

Gets information about a Task.

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 (TasksClient tasksClient = TasksClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]");
   Task response = tasksClient.getTask(name);
 }
Parameter
Name Description
name TaskName

Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
Returns
Type Description
Task

getTask(String name)

public final Task getTask(String name)

Gets information about a Task.

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 (TasksClient tasksClient = TasksClient.create()) {
   String name =
       TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]").toString();
   Task response = tasksClient.getTask(name);
 }
Parameter
Name Description
name String

Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
Returns
Type Description
Task

getTaskCallable()

public final UnaryCallable<GetTaskRequest,Task> getTaskCallable()

Gets information about a Task.

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 (TasksClient tasksClient = TasksClient.create()) {
   GetTaskRequest request =
       GetTaskRequest.newBuilder()
           .setName(
               TaskName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]", "[TASK]")
                   .toString())
           .build();
   ApiFuture<Task> future = tasksClient.getTaskCallable().futureCall(request);
   // Do something.
   Task response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTaskRequest,Task>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listTasks(ExecutionName parent)

public final TasksClient.ListTasksPagedResponse listTasks(ExecutionName parent)

Lists Tasks from an Execution of a Job.

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 (TasksClient tasksClient = TasksClient.create()) {
   ExecutionName parent = ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]");
   for (Task element : tasksClient.listTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ExecutionName

Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
Returns
Type Description
TasksClient.ListTasksPagedResponse

listTasks(ListTasksRequest request)

public final TasksClient.ListTasksPagedResponse listTasks(ListTasksRequest request)

Lists Tasks from an Execution of a Job.

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 (TasksClient tasksClient = TasksClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Task element : tasksClient.listTasks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListTasksRequest

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

listTasks(String parent)

public final TasksClient.ListTasksPagedResponse listTasks(String parent)

Lists Tasks from an Execution of a Job.

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 (TasksClient tasksClient = TasksClient.create()) {
   String parent =
       ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString();
   for (Task element : tasksClient.listTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
Returns
Type Description
TasksClient.ListTasksPagedResponse

listTasksCallable()

public final UnaryCallable<ListTasksRequest,ListTasksResponse> listTasksCallable()

Lists Tasks from an Execution of a Job.

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 (TasksClient tasksClient = TasksClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListTasksResponse response = tasksClient.listTasksCallable().call(request);
     for (Task element : response.getTasksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListTasksRequest,ListTasksResponse>

listTasksPagedCallable()

public final UnaryCallable<ListTasksRequest,TasksClient.ListTasksPagedResponse> listTasksPagedCallable()

Lists Tasks from an Execution of a Job.

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 (TasksClient tasksClient = TasksClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(
               ExecutionName.of("[PROJECT]", "[LOCATION]", "[JOB]", "[EXECUTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Task> future = tasksClient.listTasksPagedCallable().futureCall(request);
   // Do something.
   for (Task element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTasksRequest,ListTasksPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()