Class CloudTasksGrpc.CloudTasksStub (2.28.0)

public static final class CloudTasksGrpc.CloudTasksStub extends AbstractAsyncStub<CloudTasksGrpc.CloudTasksStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > CloudTasksGrpc.CloudTasksStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<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()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

acknowledgeTask(AcknowledgeTaskRequest request, StreamObserver<Empty> responseObserver)

public void acknowledgeTask(AcknowledgeTaskRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name	Description
`request`	`AcknowledgeTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

bufferTask(BufferTaskRequest request, StreamObserver<BufferTaskResponse> responseObserver)

public void bufferTask(BufferTaskRequest request, StreamObserver<BufferTaskResponse> responseObserver)

Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer. Note: This feature is in its experimental stage. You must request access to the API through the Cloud Tasks BufferTask Experiment Signup form.

Parameters
Name	Description
`request`	`BufferTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<BufferTaskResponse>`

build(Channel channel, CallOptions callOptions)

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

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`CloudTasksGrpc.CloudTasksStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelLease(CancelLeaseRequest request, StreamObserver<Task> responseObserver)

public void cancelLease(CancelLeaseRequest request, StreamObserver<Task> responseObserver)

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.

Parameters
Name	Description
`request`	`CancelLeaseRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Task>`

createQueue(CreateQueueRequest request, StreamObserver<Queue> responseObserver)

public void createQueue(CreateQueueRequest request, StreamObserver<Queue> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

createTask(CreateTaskRequest request, StreamObserver<Task> responseObserver)

public void createTask(CreateTaskRequest request, StreamObserver<Task> responseObserver)

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.

Parameters
Name	Description
`request`	`CreateTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Task>`

deleteQueue(DeleteQueueRequest request, StreamObserver<Empty> responseObserver)

public void deleteQueue(DeleteQueueRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name	Description
`request`	`DeleteQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTask(DeleteTaskRequest request, StreamObserver<Empty> responseObserver)

public void deleteTask(DeleteTaskRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
Name	Description
`request`	`DeleteTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

getQueue(GetQueueRequest request, StreamObserver<Queue> responseObserver)

public void getQueue(GetQueueRequest request, StreamObserver<Queue> responseObserver)

Gets a queue.

Parameters
Name	Description
`request`	`GetQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

getTask(GetTaskRequest request, StreamObserver<Task> responseObserver)

public void getTask(GetTaskRequest request, StreamObserver<Task> responseObserver)

Gets a task.

Parameters
Name	Description
`request`	`GetTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Task>`

leaseTasks(LeaseTasksRequest request, StreamObserver<LeaseTasksResponse> responseObserver)

public void leaseTasks(LeaseTasksRequest request, StreamObserver<LeaseTasksResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`LeaseTasksRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<LeaseTasksResponse>`

listQueues(ListQueuesRequest request, StreamObserver<ListQueuesResponse> responseObserver)

public void listQueues(ListQueuesRequest request, StreamObserver<ListQueuesResponse> responseObserver)

Lists queues. Queues are returned in lexicographical order.

Parameters
Name	Description
`request`	`ListQueuesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListQueuesResponse>`

listTasks(ListTasksRequest request, StreamObserver<ListTasksResponse> responseObserver)

public void listTasks(ListTasksRequest request, StreamObserver<ListTasksResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`ListTasksRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListTasksResponse>`

pauseQueue(PauseQueueRequest request, StreamObserver<Queue> responseObserver)

public void pauseQueue(PauseQueueRequest request, StreamObserver<Queue> responseObserver)

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.

Parameters
Name	Description
`request`	`PauseQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

purgeQueue(PurgeQueueRequest request, StreamObserver<Queue> responseObserver)

public void purgeQueue(PurgeQueueRequest request, StreamObserver<Queue> responseObserver)

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.

Parameters
Name	Description
`request`	`PurgeQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

renewLease(RenewLeaseRequest request, StreamObserver<Task> responseObserver)

public void renewLease(RenewLeaseRequest request, StreamObserver<Task> responseObserver)

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.

Parameters
Name	Description
`request`	`RenewLeaseRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Task>`

resumeQueue(ResumeQueueRequest request, StreamObserver<Queue> responseObserver)

public void resumeQueue(ResumeQueueRequest request, StreamObserver<Queue> responseObserver)

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.

Parameters
Name	Description
`request`	`ResumeQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

runTask(RunTaskRequest request, StreamObserver<Task> responseObserver)

public void runTask(RunTaskRequest request, StreamObserver<Task> responseObserver)

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.

Parameters
Name	Description
`request`	`RunTaskRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Task>`

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

Parameters
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>`

updateQueue(UpdateQueueRequest request, StreamObserver<Queue> responseObserver)

public void updateQueue(UpdateQueueRequest request, StreamObserver<Queue> responseObserver)

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.

Parameters
Name	Description
`request`	`UpdateQueueRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Queue>`

uploadQueueYaml(UploadQueueYamlRequest request, StreamObserver<Empty> responseObserver)

public void uploadQueueYaml(UploadQueueYamlRequest request, StreamObserver<Empty> responseObserver)

Update queue list by uploading a queue.yaml file. The queue.yaml file is supplied in the request body as a YAML encoded string. This method was added to support gcloud clients versions before 322.0.0. New clients should use CreateQueue instead of this method.

Parameters
Name	Description
`request`	`UploadQueueYamlRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`