Method: projects.locations.queues.pause

Pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via queues.resume. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

HTTP request

POST https://cloudtasks.googleapis.com/v2/{name=projects/*/locations/*/queues/*}:pause

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Authorization requires the following IAM permission on the specified resource name:

  • cloudtasks.queues.pause

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Queue.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-tasks

For more information, see the Authentication Overview.