Enum State

#[repr(i32)]
pub enum State {
    Unspecified = 0,
    Running = 1,
    Paused = 2,
    Disabled = 3,
}

State of the queue.

Variants

Unspecified = 0

Unspecified state.

Running = 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][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 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].

Disabled = 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 and [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls return a FAILED_PRECONDITION error.

To permanently delete this queue and all of its tasks, call [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].

Implementations

impl State

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of State.

pub fn from_i32(value: i32) -> Option<State>

Converts an i32 to a State, or None if value is not a valid variant.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for State

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl From<State> for i32

fn from(value: State) -> i32

Converts to this type from the input type.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for State

fn cmp(&self, other: &State) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for State

fn eq(&self, other: &State) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for State

fn partial_cmp(&self, other: &State) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for State

impl Eq for State

impl StructuralPartialEq for State