com.google.cloud.tasks.v2

Class CloudTasksGrpc.CloudTasksFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<CloudTasksGrpc.CloudTasksFutureStub>

com.google.cloud.tasks.v2.CloudTasksGrpc.CloudTasksFutureStub

Enclosing class:

CloudTasksGrpc

public static final class CloudTasksGrpc.CloudTasksFutureStub
extends AbstractFutureStub<CloudTasksGrpc.CloudTasksFutureStub>

 Cloud Tasks allows developers to manage the execution of background
 work in their applications.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected CloudTasksGrpc.CloudTasksFutureStub	build(Channel channel, CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Queue>	createQueue(CreateQueueRequest request) Creates a queue.
com.google.common.util.concurrent.ListenableFuture<Task>	createTask(CreateTaskRequest request) Creates a task and adds it to a queue.
com.google.common.util.concurrent.ListenableFuture<Empty>	deleteQueue(DeleteQueueRequest request) Deletes a queue.
com.google.common.util.concurrent.ListenableFuture<Empty>	deleteTask(DeleteTaskRequest request) Deletes a task.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
com.google.common.util.concurrent.ListenableFuture<Queue>	getQueue(GetQueueRequest request) Gets a queue.
com.google.common.util.concurrent.ListenableFuture<Task>	getTask(GetTaskRequest request) Gets a task.
com.google.common.util.concurrent.ListenableFuture<ListQueuesResponse>	listQueues(ListQueuesRequest request) Lists queues.
com.google.common.util.concurrent.ListenableFuture<ListTasksResponse>	listTasks(ListTasksRequest request) Lists the tasks in a queue.
com.google.common.util.concurrent.ListenableFuture<Queue>	pauseQueue(PauseQueueRequest request) Pauses the queue.
com.google.common.util.concurrent.ListenableFuture<Queue>	purgeQueue(PurgeQueueRequest request) Purges a queue by deleting all of its tasks.
com.google.common.util.concurrent.ListenableFuture<Queue>	resumeQueue(ResumeQueueRequest request) Resume a queue.
com.google.common.util.concurrent.ListenableFuture<Task>	runTask(RunTaskRequest request) Forces a task to run now.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
com.google.common.util.concurrent.ListenableFuture<Queue>	updateQueue(UpdateQueueRequest request) Updates a queue.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected CloudTasksGrpc.CloudTasksFutureStub build(Channel channel,
                                                    CallOptions callOptions)

Specified by:

build in class AbstractStub<CloudTasksGrpc.CloudTasksFutureStub>

listQueues

public com.google.common.util.concurrent.ListenableFuture<ListQueuesResponse> listQueues(ListQueuesRequest request)

 Lists queues.
 Queues are returned in lexicographical order.
 

getQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> getQueue(GetQueueRequest request)

 Gets a queue.
 

createQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> createQueue(CreateQueueRequest request)

 Creates a queue.
 Queues created with this method allow tasks to live for a maximum of 31
 days. After a task is 31 days old, the task will be deleted regardless of whether
 it was dispatched or not.
 WARNING: Using this method may have unintended side effects if you are
 using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
 Read
 [Overview of Queue Management and
 queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.
 

updateQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> updateQueue(UpdateQueueRequest request)

 Updates a queue.
 This method creates the queue if it does not exist and updates
 the queue if it does exist.
 Queues created with this method allow tasks to live for a maximum of 31
 days. After a task is 31 days old, the task will be deleted regardless of whether
 it was dispatched or not.
 WARNING: Using this method may have unintended side effects if you are
 using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
 Read
 [Overview of Queue Management and
 queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.
 

deleteQueue

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteQueue(DeleteQueueRequest request)

 Deletes a queue.
 This command will delete the queue even if it has tasks in it.
 Note: If you delete a queue, a queue with the same name can't be created
 for 7 days.
 WARNING: Using this method may have unintended side effects if you are
 using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
 Read
 [Overview of Queue Management and
 queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.
 

purgeQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> purgeQueue(PurgeQueueRequest request)

 Purges a queue by deleting all of its tasks.
 All tasks created before this method is called are permanently deleted.
 Purge operations can take up to one minute to take effect. Tasks
 might be dispatched before the purge takes effect. A purge is irreversible.
 

pauseQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> pauseQueue(PauseQueueRequest request)

 Pauses the queue.
 If a queue is paused then the system will stop dispatching tasks
 until the queue is resumed via
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
 when the queue is paused. A queue is paused if its
 [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
 

resumeQueue

public com.google.common.util.concurrent.ListenableFuture<Queue> resumeQueue(ResumeQueueRequest request)

 Resume a queue.
 This method resumes a queue after it has been
 [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
 [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
 in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
 will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
 WARNING: Resuming many high-QPS queues at the same time can
 lead to target overloading. If you are resuming high-QPS
 queues, follow the 500/50/5 pattern described in
 [Managing Cloud Tasks Scaling
 Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
 

getIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

 Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
 Returns an empty policy if the resource exists and does not have a policy
 set.
 Authorization requires the following
 [Google IAM](https://cloud.google.com/iam) permission on the specified
 resource parent:
 * `cloudtasks.queues.getIamPolicy`
 

setIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

 Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
 policy.
 Note: The Cloud Console does not check queue-level IAM permissions yet.
 Project-level permissions are required to use the Cloud Console.
 Authorization requires the following
 [Google IAM](https://cloud.google.com/iam) permission on the specified
 resource parent:
 * `cloudtasks.queues.setIamPolicy`
 

testIamPermissions

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
 If the resource does not exist, this will return an empty set of
 permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
 Note: This operation is designed to be used for building permission-aware
 UIs and command-line tools, not for authorization checking. This operation
 may "fail open" without warning.
 

listTasks

public com.google.common.util.concurrent.ListenableFuture<ListTasksResponse> listTasks(ListTasksRequest request)

 Lists the tasks in a queue.
 By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
 due to performance considerations;
 [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view] controls the
 subset of information which is returned.
 The tasks may be returned in any order. The ordering may change at any
 time.
 

getTask

public com.google.common.util.concurrent.ListenableFuture<Task> getTask(GetTaskRequest request)

 Gets a task.
 

createTask

public com.google.common.util.concurrent.ListenableFuture<Task> createTask(CreateTaskRequest request)

 Creates a task and adds it to a queue.
 Tasks cannot be updated after creation; there is no UpdateTask command.
 * The maximum task size is 100KB.
 

deleteTask

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteTask(DeleteTaskRequest request)

 Deletes a task.
 A task can be deleted if it is scheduled or dispatched. A task
 cannot be deleted if it has executed successfully or permanently
 failed.
 

runTask

public com.google.common.util.concurrent.ListenableFuture<Task> runTask(RunTaskRequest request)

 Forces a task to run now.
 When this method is called, Cloud Tasks will dispatch the task, even if
 the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits] or
 is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
 This command is meant to be used for manual debugging. For
 example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to retry a failed
 task after a fix has been made or to manually force a task to be
 dispatched now.
 The dispatched task is returned. That is, the task that is returned
 contains the [status][Task.status] after the task is dispatched but
 before the task is received by its target.
 If Cloud Tasks receives a successful response from the task's
 target, then the task will be deleted; otherwise the task's
 [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
 [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
 in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
 [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
 [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
 task that has already succeeded or permanently failed.