Class State (2.17.0)

State(value)

State of the queue.

    If the queue was created using Cloud Tasks and the queue has
    had no activity (method calls or task dispatches) for 30
    days, the queue may take a few minutes to re-activate. Some
    method calls may return
    `NOT_FOUND][google.rpc.Code.NOT_FOUND]` and tasks may not be
    dispatched for a few minutes until the queue has been
    re-activated.
PAUSED (2):
    Tasks are paused by the user. If the queue is paused then
    Cloud Tasks will stop delivering tasks from it, but more
    tasks can still be added to it by the user. When a pull
    queue is paused, all
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks">LeaseTasks</xref>
    calls will return a
    `FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]`.
DISABLED (3):
    The queue is disabled.

    A queue becomes `DISABLED` when
    `queue.yaml <https://cloud.google.com/appengine/docs/python/config/queueref>`__
    or
    `queue.xml <https://cloud.google.com/appengine/docs/standard/java/config/queueref>`__
    is uploaded which does not contain the queue. You cannot
    directly disable a queue.

    When a queue is disabled, tasks can still be added to a
    queue but the tasks are not dispatched and
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks">LeaseTasks</xref>
    calls return a `FAILED_PRECONDITION` error.

    To permanently delete this queue and all of its tasks, call
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue">DeleteQueue</xref>.

Enums

Name Description
STATE_UNSPECIFIED Unspecified state.
RUNNING The queue is running. Tasks can be dispatched.