Package com.google.cloud.tasks.v2beta2

Interface CloudTasksGrpc.AsyncService

  • All Known Implementing Classes:
    CloudTasksGrpc.CloudTasksImplBase
    Enclosing class:
    CloudTasksGrpc
    public static interface CloudTasksGrpc.AsyncService
     Cloud Tasks allows developers to manage the execution of background
 work in their applications.

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void acknowledgeTask​(AcknowledgeTaskRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Acknowledges a pull task.
      default void bufferTask​(BufferTaskRequest request, io.grpc.stub.StreamObserver<BufferTaskResponse> responseObserver)
      Creates and buffers a new task without the need to explicitly define a Task message.
      default void cancelLease​(CancelLeaseRequest request, io.grpc.stub.StreamObserver<Task> responseObserver)
      Cancel a pull task's lease.
      default void createQueue​(CreateQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Creates a queue.
      default void createTask​(CreateTaskRequest request, io.grpc.stub.StreamObserver<Task> responseObserver)
      Creates a task and adds it to a queue.
      default void deleteQueue​(DeleteQueueRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Deletes a queue.
      default void deleteTask​(DeleteTaskRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Deletes a task.
      default void getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
      Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
      default void getQueue​(GetQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Gets a queue.
      default void getTask​(GetTaskRequest request, io.grpc.stub.StreamObserver<Task> responseObserver)
      Gets a task.
      default void leaseTasks​(LeaseTasksRequest request, io.grpc.stub.StreamObserver<LeaseTasksResponse> responseObserver)
      Leases tasks from a pull queue for [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
      default void listQueues​(ListQueuesRequest request, io.grpc.stub.StreamObserver<ListQueuesResponse> responseObserver)
      Lists queues.
      default void listTasks​(ListTasksRequest request, io.grpc.stub.StreamObserver<ListTasksResponse> responseObserver)
      Lists the tasks in a queue.
      default void pauseQueue​(PauseQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Pauses the queue.
      default void purgeQueue​(PurgeQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Purges a queue by deleting all of its tasks.
      default void renewLease​(RenewLeaseRequest request, io.grpc.stub.StreamObserver<Task> responseObserver)
      Renew the current lease of a pull task.
      default void resumeQueue​(ResumeQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Resume a queue.
      default void runTask​(RunTaskRequest request, io.grpc.stub.StreamObserver<Task> responseObserver)
      Forces a task to run now.
      default void setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
      Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
      default void testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
      Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
      default void updateQueue​(UpdateQueueRequest request, io.grpc.stub.StreamObserver<Queue> responseObserver)
      Updates a queue.
      default void uploadQueueYaml​(UploadQueueYamlRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Update queue list by uploading a queue.yaml file.

    • Method Detail

      • listQueues

        default void listQueues​(ListQueuesRequest request,
                        io.grpc.stub.StreamObserver<ListQueuesResponse> responseObserver)
         Lists queues.
 Queues are returned in lexicographical order.

      • getQueue

        default void getQueue​(GetQueueRequest request,
                      io.grpc.stub.StreamObserver<Queue> responseObserver)
         Gets a queue.

      • createQueue

        default void createQueue​(CreateQueueRequest request,
                         io.grpc.stub.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](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.

      • updateQueue

        default void updateQueue​(UpdateQueueRequest request,
                         io.grpc.stub.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](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.

      • deleteQueue

        default void deleteQueue​(DeleteQueueRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.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](https://cloud.google.com/tasks/docs/queue-yaml) before using
 this method.

      • purgeQueue

        default void purgeQueue​(PurgeQueueRequest request,
                        io.grpc.stub.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.

      • pauseQueue

        default void pauseQueue​(PauseQueueRequest request,
                        io.grpc.stub.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][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

        default void resumeQueue​(ResumeQueueRequest request,
                         io.grpc.stub.StreamObserver<Queue> responseObserver)
         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).

      • uploadQueueYaml

        default void uploadQueueYaml​(UploadQueueYamlRequest request,
                             io.grpc.stub.StreamObserver<com.google.protobuf.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.

      • getIamPolicy

        default void getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request,
                          io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
         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

        default void setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request,
                          io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
         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

        default void testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request,
                                io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
         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

        default void listTasks​(ListTasksRequest request,
                       io.grpc.stub.StreamObserver<ListTasksResponse> responseObserver)
         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

        default void getTask​(GetTaskRequest request,
                     io.grpc.stub.StreamObserver<Task> responseObserver)
         Gets a task.

      • createTask

        default void createTask​(CreateTaskRequest request,
                        io.grpc.stub.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][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

        default void deleteTask​(DeleteTaskRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.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.

      • leaseTasks

        default void leaseTasks​(LeaseTasksRequest request,
                        io.grpc.stub.StreamObserver<LeaseTasksResponse> responseObserver)
         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

        default void acknowledgeTask​(AcknowledgeTaskRequest request,
                             io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         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

        default void renewLease​(RenewLeaseRequest request,
                        io.grpc.stub.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][google.cloud.tasks.v2beta2.Task.schedule_time].

      • cancelLease

        default void cancelLease​(CancelLeaseRequest request,
                         io.grpc.stub.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][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

        default void runTask​(RunTaskRequest request,
                     io.grpc.stub.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][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].

      • bufferTask

        default void bufferTask​(BufferTaskRequest request,
                        io.grpc.stub.StreamObserver<BufferTaskResponse> responseObserver)
         Creates and buffers a new task without the need to explicitly define a Task
 message. The queue must have [HTTP
 target][google.cloud.tasks.v2beta2.HttpTarget]. 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](https://forms.gle/X8Zr5hiXH5tTGFqh8).