Method: googleapis.cloudtasks.v2.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 ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

Arguments

Parameters
name

string

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

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Queue.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- pause:
    call: googleapis.cloudtasks.v2.projects.locations.queues.pause
    args:
        name: ...
    result: pauseResult

JSON

[
  {
    "pause": {
      "call": "googleapis.cloudtasks.v2.projects.locations.queues.pause",
      "args": {
        "name": "..."
      },
      "result": "pauseResult"
    }
  }
]