public static final class CloudTasksGrpc.CloudTasksFutureStub extends AbstractFutureStub<CloudTasksGrpc.CloudTasksFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service CloudTasks.
Cloud Tasks allows developers to manage the execution of background
work in their applications.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
CloudTasksGrpc.CloudTasksFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
acknowledgeTask(AcknowledgeTaskRequest request)
public ListenableFuture<Empty> acknowledgeTask(AcknowledgeTaskRequest request)
Acknowledges a pull task.
The worker, that is, the entity that
leased 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
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,
GetTask, or
ListTasks.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
build(Channel channel, CallOptions callOptions)
protected CloudTasksGrpc.CloudTasksFutureStub build(Channel channel, CallOptions callOptions)
| Parameters |
|---|
| Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
cancelLease(CancelLeaseRequest request)
public ListenableFuture<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
to now. This will make the task available to be leased to the next caller
of LeaseTasks.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Task> | |
createQueue(CreateQueueRequest request)
public 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 before using
this method.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
createTask(CreateTaskRequest request)
public 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.
- For App Engine queues,
the maximum task size is
100KB.
- For pull queues, the maximum
task size is 1MB.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Task> | |
deleteQueue(DeleteQueueRequest request)
public 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 before using
this method.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteTask(DeleteTaskRequest request)
public 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 completed successfully or permanently
failed.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
getIamPolicy(GetIamPolicyRequest request)
public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a
Queue. Returns an empty policy if the
resource exists and does not have a policy set.
Authorization requires the following
Google IAM permission on the specified
resource parent:
cloudtasks.queues.getIamPolicy
| Parameter |
|---|
| Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest
|
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
getQueue(GetQueueRequest request)
public ListenableFuture<Queue> getQueue(GetQueueRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
getTask(GetTaskRequest request)
public ListenableFuture<Task> getTask(GetTaskRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Task> | |
leaseTasks(LeaseTasksRequest request)
public ListenableFuture<LeaseTasksResponse> leaseTasks(LeaseTasksRequest request)
Leases tasks from a pull queue for
lease_duration.
This method is invoked by the worker to obtain a lease. The
worker must acknowledge the task via
AcknowledgeTask
after they have performed the work associated with the task.
The 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, set
response_view
to FULL.
A maximum of 10 qps of
LeaseTasks requests are
allowed per queue. RESOURCE_EXHAUSTED
is returned when this limit is
exceeded. RESOURCE_EXHAUSTED
is also returned when
max_tasks_dispatched_per_second
is exceeded.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<LeaseTasksResponse> | |
listQueues(ListQueuesRequest request)
public ListenableFuture<ListQueuesResponse> listQueues(ListQueuesRequest request)
Lists queues.
Queues are returned in lexicographical order.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ListQueuesResponse> | |
listTasks(ListTasksRequest request)
public ListenableFuture<ListTasksResponse> listTasks(ListTasksRequest request)
Lists the tasks in a queue.
By default, only the BASIC
view is retrieved due to performance considerations;
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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ListTasksResponse> | |
pauseQueue(PauseQueueRequest request)
public 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. Tasks can
still be added when the queue is paused. A queue is paused if its
state is
PAUSED.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
purgeQueue(PurgeQueueRequest request)
public 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
renewLease(RenewLeaseRequest request)
public ListenableFuture<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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Task> | |
resumeQueue(ResumeQueueRequest request)
public ListenableFuture<Queue> resumeQueue(ResumeQueueRequest request)
Resume a queue.
This method resumes a queue after it has been
PAUSED or
DISABLED. The state of a
queue is stored in the queue's
state; after calling this method
it will be set to
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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
runTask(RunTaskRequest request)
public 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 or is
PAUSED.
This command is meant to be used for manual debugging. For
example, 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 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 will be
reset to the time that
RunTask was called plus
the retry delay specified in the queue's
RetryConfig.
RunTask returns
NOT_FOUND when it is called on a
task that has already succeeded or permanently failed.
RunTask cannot be called
on a pull task.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Task> | |
setIamPolicy(SetIamPolicyRequest request)
public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy for a
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 permission on the specified
resource parent:
cloudtasks.queues.setIamPolicy
| Parameter |
|---|
| Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest
|
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
testIamPermissions(TestIamPermissionsRequest request)
public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on a
Queue. If the resource does not exist,
this will return an empty set of permissions, not a
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.
| Parameter |
|---|
| Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest
|
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> | |
updateQueue(UpdateQueueRequest request)
public 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 before using
this method.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Queue> | |
