Google Cloud Tasks V2 Client - Class State (1.15.0)

Reference documentation and code samples for the Google Cloud Tasks V2 Client class State.

State of the queue.

Protobuf type google.cloud.tasks.v2.Queue.State

Namespace

Google \ Cloud \ Tasks \ V2 \ Queue

Methods

static::name

Parameter
Name	Description
`value`	`mixed`

static::value

Parameter
Name	Description
`name`	`mixed`

Constants

STATE_UNSPECIFIED

Value: 0

Unspecified state.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

RUNNING

Value: 1

The queue is running. Tasks can be dispatched.

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 and tasks may not be dispatched for a few minutes until the queue has been re-activated.

Generated from protobuf enum RUNNING = 1;

PAUSED

Value: 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.

Generated from protobuf enum PAUSED = 2;

DISABLED

Value: 3

The queue is disabled.

A queue becomes DISABLED when queue.yaml or queue.xml 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. To permanently delete this queue and all of its tasks, call DeleteQueue.

Generated from protobuf enum DISABLED = 3;