com.google.cloud.tasks.v2beta2

Class CloudTasksGrpc.CloudTasksBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<CloudTasksGrpc.CloudTasksBlockingStub>

com.google.cloud.tasks.v2beta2.CloudTasksGrpc.CloudTasksBlockingStub

Enclosing class:

CloudTasksGrpc

public static final class CloudTasksGrpc.CloudTasksBlockingStub
extends AbstractBlockingStub<CloudTasksGrpc.CloudTasksBlockingStub>

 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
Empty	acknowledgeTask(AcknowledgeTaskRequest request) Acknowledges a pull task.
protected CloudTasksGrpc.CloudTasksBlockingStub	build(Channel channel, CallOptions callOptions)
Task	cancelLease(CancelLeaseRequest request) Cancel a pull task's lease.
Queue	createQueue(CreateQueueRequest request) Creates a queue.
Task	createTask(CreateTaskRequest request) Creates a task and adds it to a queue.
Empty	deleteQueue(DeleteQueueRequest request) Deletes a queue.
Empty	deleteTask(DeleteTaskRequest request) Deletes a task.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
Queue	getQueue(GetQueueRequest request) Gets a queue.
Task	getTask(GetTaskRequest request) Gets a task.
LeaseTasksResponse	leaseTasks(LeaseTasksRequest request) Leases tasks from a pull queue for [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
ListQueuesResponse	listQueues(ListQueuesRequest request) Lists queues.
ListTasksResponse	listTasks(ListTasksRequest request) Lists the tasks in a queue.
Queue	pauseQueue(PauseQueueRequest request) Pauses the queue.
Queue	purgeQueue(PurgeQueueRequest request) Purges a queue by deleting all of its tasks.
Task	renewLease(RenewLeaseRequest request) Renew the current lease of a pull task.
Queue	resumeQueue(ResumeQueueRequest request) Resume a queue.
Task	runTask(RunTaskRequest request) Forces a task to run now.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
Queue	updateQueue(UpdateQueueRequest request) Updates a queue.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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.CloudTasksBlockingStub build(Channel channel,
                                                      CallOptions callOptions)

Specified by:

build in class AbstractStub<CloudTasksGrpc.CloudTasksBlockingStub>

listQueues

public ListQueuesResponse listQueues(ListQueuesRequest request)

 Lists queues.
 Queues are returned in lexicographical order.
 

getQueue

public Queue getQueue(GetQueueRequest request)

 Gets a queue.
 

createQueue

public 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 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 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 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 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.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added
 when the queue is paused. A queue is paused if its
 [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
 

resumeQueue

public Queue resumeQueue(ResumeQueueRequest request)

 Resume a queue.
 This method resumes a queue after it has been
 [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or
 [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored
 in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it
 will be set to [RUNNING][google.cloud.tasks.v2beta2.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.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

 Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.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.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

 Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.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.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.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 ListTasksResponse listTasks(ListTasksRequest request)

 Lists the tasks in a queue.
 By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved
 due to performance considerations;
 [response_view][google.cloud.tasks.v2beta2.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 Task getTask(GetTaskRequest request)

 Gets a task.
 

createTask

public Task createTask(CreateTaskRequest request)

 Creates a task and adds it to a queue.
 Tasks cannot be updated after creation; there is no UpdateTask command.
 * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is
   100KB.
 * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB.
 

deleteTask

public 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 completed successfully or permanently
 failed.
 

leaseTasks

public LeaseTasksResponse leaseTasks(LeaseTasksRequest request)

 Leases tasks from a pull queue for
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
 This method is invoked by the worker to obtain a lease. The
 worker must acknowledge the task via
 [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have
 performed the work associated with the task.
 The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that
 the worker needs to perform the work associated with the task. To
 return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
 [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to
 [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
 A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
 requests are allowed per
 queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
 is returned when this limit is
 exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
 is also returned when
 [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
 is exceeded.
 

acknowledgeTask

public Empty acknowledgeTask(AcknowledgeTaskRequest request)

 Acknowledges a pull task.
 The worker, that is, the entity that
 [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method
 to indicate that the work associated with the task has finished.
 The worker must acknowledge a task within the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease
 will expire and the task will become available to be leased
 again. After the task is acknowledged, it will not be returned
 by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
 [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
 [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
 

renewLease

public Task renewLease(RenewLeaseRequest request)

 Renew the current lease of a pull task.
 The worker can use this method to extend the lease by a new
 duration, starting from now. The new task lease will be
 returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
 

cancelLease

public Task cancelLease(CancelLeaseRequest request)

 Cancel a pull task's lease.
 The worker can use this method to cancel a task's lease by
 setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will
 make the task available to be leased to the next caller of
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
 

runTask

public 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.v2beta2.RateLimits] or
 is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
 This command is meant to be used for manual debugging. For
 example, [RunTask][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.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.v2beta2.Task.schedule_time] will be reset to the time that
 [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified
 in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
 [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns
 [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
 task that has already succeeded or permanently failed.
 [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a
 [pull task][google.cloud.tasks.v2beta2.PullMessage].