TasksClient (Google Cloud Run 0.67.0 API)

java.lang.Object
- com.google.cloud.run.v2.TasksClient

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

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

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TasksClient.ListTasksFixedSizeCollection`
`static class`	`TasksClient.ListTasksPage`
`static class`	`TasksClient.ListTasksPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TasksClient(TasksSettings settings)` Constructs an instance of TasksClient, using the given settings.
`protected`	`TasksClient(TasksStub 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 TasksClient`	`create()` Constructs an instance of TasksClient with default settings.
`static TasksClient`	`create(TasksSettings settings)` Constructs an instance of TasksClient, using the given settings.
`static TasksClient`	`create(TasksStub stub)` Constructs an instance of TasksClient, using the given stub for making calls.
`TasksSettings`	`getSettings()`
`TasksStub`	`getStub()`
`Task`	`getTask(GetTaskRequest request)` Gets information about a Task.
`Task`	`getTask(String name)` Gets information about a Task.
`Task`	`getTask(TaskName name)` Gets information about a Task.
`com.google.api.gax.rpc.UnaryCallable<GetTaskRequest,Task>`	`getTaskCallable()` Gets information about a Task.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TasksClient.ListTasksPagedResponse`	`listTasks(ExecutionName parent)` Lists Tasks from an Execution of a Job.
`TasksClient.ListTasksPagedResponse`	`listTasks(ListTasksRequest request)` Lists Tasks from an Execution of a Job.
`TasksClient.ListTasksPagedResponse`	`listTasks(String parent)` Lists Tasks from an Execution of a Job.
`com.google.api.gax.rpc.UnaryCallable<ListTasksRequest,ListTasksResponse>`	`listTasksCallable()` Lists Tasks from an Execution of a Job.
`com.google.api.gax.rpc.UnaryCallable<ListTasksRequest,TasksClient.ListTasksPagedResponse>`	`listTasksPagedCallable()` Lists Tasks from an Execution of a Job.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- TasksClient
```
protected TasksClient(TasksSettings settings)
               throws IOException
```
  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.
  
  Throws:
  
  IOException
- TasksClient
```
protected TasksClient(TasksStub stub)
```

Method Detail

create

public static final TasksClient create()
                                throws IOException

Constructs an instance of TasksClient with default settings.

Throws:: IOException

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

Throws:

IOException

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

getSettings

public final TasksSettings getSettings()

getStub
```
public TasksStub getStub()
```

getTask

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);
 }

Parameters:: name - Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTask

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);
 }

Parameters:: name - Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTask

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTaskCallable

public final com.google.api.gax.rpc.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();
 }