Package com.google.cloud.tasks.v2beta2

Class CloudTasksGrpc.CloudTasksBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<CloudTasksGrpc.CloudTasksBlockingV2Stub>
com.google.cloud.tasks.v2beta2.CloudTasksGrpc.CloudTasksBlockingV2Stub
Enclosing class:
CloudTasksGrpc
public static final class CloudTasksGrpc.CloudTasksBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<CloudTasksGrpc.CloudTasksBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service CloudTasks. 
 Cloud Tasks allows developers to manage the execution of background
 work in their applications.

  • Method Details

    • build

      protected CloudTasksGrpc.CloudTasksBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<CloudTasksGrpc.CloudTasksBlockingV2Stub>

    • listQueues

      public ListQueuesResponse listQueues(ListQueuesRequest request) throws io.grpc.StatusException
       Lists queues.
 Queues are returned in lexicographical order.
      Throws:
      io.grpc.StatusException

    • getQueue

      public Queue getQueue(GetQueueRequest request) throws io.grpc.StatusException
       Gets a queue.
      Throws:
      io.grpc.StatusException

    • createQueue

      public Queue createQueue(CreateQueueRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • updateQueue

      public Queue updateQueue(UpdateQueueRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • deleteQueue

      public com.google.protobuf.Empty deleteQueue(DeleteQueueRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • purgeQueue

      public Queue purgeQueue(PurgeQueueRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • pauseQueue

      public Queue pauseQueue(PauseQueueRequest request) throws io.grpc.StatusException
       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].
      Throws:
      io.grpc.StatusException

    • resumeQueue

      public Queue resumeQueue(ResumeQueueRequest request) throws io.grpc.StatusException
       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).
      Throws:
      io.grpc.StatusException

    • uploadQueueYaml

      public com.google.protobuf.Empty uploadQueueYaml(UploadQueueYamlRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • getIamPolicy

      public Policy getIamPolicy(GetIamPolicyRequest request) throws io.grpc.StatusException
       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`
      Throws:
      io.grpc.StatusException

    • setIamPolicy

      public Policy setIamPolicy(SetIamPolicyRequest request) throws io.grpc.StatusException
       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`
      Throws:
      io.grpc.StatusException

    • testIamPermissions

      public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • listTasks

      public ListTasksResponse listTasks(ListTasksRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • getTask

      public Task getTask(GetTaskRequest request) throws io.grpc.StatusException
       Gets a task.
      Throws:
      io.grpc.StatusException

    • createTask

      public Task createTask(CreateTaskRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • deleteTask

      public com.google.protobuf.Empty deleteTask(DeleteTaskRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • leaseTasks

      public LeaseTasksResponse leaseTasks(LeaseTasksRequest request) throws io.grpc.StatusException
       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.
      Throws:
      io.grpc.StatusException

    • acknowledgeTask

      public com.google.protobuf.Empty acknowledgeTask(AcknowledgeTaskRequest request) throws io.grpc.StatusException
       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].
      Throws:
      io.grpc.StatusException

    • renewLease

      public Task renewLease(RenewLeaseRequest request) throws io.grpc.StatusException
       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].
      Throws:
      io.grpc.StatusException

    • cancelLease

      public Task cancelLease(CancelLeaseRequest request) throws io.grpc.StatusException
       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].
      Throws:
      io.grpc.StatusException

    • runTask

      public Task runTask(RunTaskRequest request) throws io.grpc.StatusException
       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].
      Throws:
      io.grpc.StatusException