com.google.cloud.tasks.v2beta2

Enum Queue.State

java.lang.Object

java.lang.Enum<Queue.State>

com.google.cloud.tasks.v2beta2.Queue.State

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, Serializable, Comparable<Queue.State>

Enclosing class:

Queue

public static enum Queue.State
extends Enum<Queue.State>
implements ProtocolMessageEnum

 State of the queue.
 

Protobuf enum google.cloud.tasks.v2beta2.Queue.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The queue is disabled.
PAUSED Tasks are paused by the user.
RUNNING The queue is running.
STATE_UNSPECIFIED Unspecified state.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISABLED_VALUE The queue is disabled.
static int	PAUSED_VALUE Tasks are paused by the user.
static int	RUNNING_VALUE The queue is running.
static int	STATE_UNSPECIFIED_VALUE Unspecified state.

Method Summary

Modifier and Type	Method and Description
static Queue.State	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<Queue.State>	internalGetValueMap()
static Queue.State	valueOf(Descriptors.EnumValueDescriptor desc)
static Queue.State	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Queue.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Queue.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATE_UNSPECIFIED

public static final Queue.State STATE_UNSPECIFIED

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

RUNNING

public static final Queue.State RUNNING

 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.
 

RUNNING = 1;

PAUSED

public static final Queue.State PAUSED

 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].
 

PAUSED = 2;

DISABLED

public static final Queue.State DISABLED

 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
 [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].
 

DISABLED = 3;

UNRECOGNIZED

public static final Queue.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

RUNNING_VALUE

public static final int RUNNING_VALUE

 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.
 

RUNNING = 1;

See Also:

Constant Field Values

PAUSED_VALUE

public static final int PAUSED_VALUE

 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].
 

PAUSED = 2;

See Also:

Constant Field Values

DISABLED_VALUE

public static final int DISABLED_VALUE

 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
 [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].
 

DISABLED = 3;

See Also:

Constant Field Values

Method Detail

values

public static Queue.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Queue.State c : Queue.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Queue.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static Queue.State valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static Queue.State forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static Internal.EnumLiteMap<Queue.State> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Queue.State valueOf(Descriptors.EnumValueDescriptor desc)