com.google.cloud.scheduler.v1

Enum Job.State

java.lang.Object

java.lang.Enum<Job.State>

com.google.cloud.scheduler.v1.Job.State

All Implemented Interfaces:

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

Enclosing class:

Job

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

 State of the job.
 

Protobuf enum google.cloud.scheduler.v1.Job.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The job is disabled by the system due to error.
ENABLED The job is executing normally.
PAUSED The job is paused by the user.
STATE_UNSPECIFIED Unspecified state.
UNRECOGNIZED
UPDATE_FAILED The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] operation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISABLED_VALUE The job is disabled by the system due to error.
static int	ENABLED_VALUE The job is executing normally.
static int	PAUSED_VALUE The job is paused by the user.
static int	STATE_UNSPECIFIED_VALUE Unspecified state.
static int	UPDATE_FAILED_VALUE The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] operation.

Method Summary

Modifier and Type	Method and Description
static Job.State	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<Job.State>	internalGetValueMap()
static Job.State	valueOf(Descriptors.EnumValueDescriptor desc)
static Job.State	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Job.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Job.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 Job.State STATE_UNSPECIFIED

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

ENABLED

public static final Job.State ENABLED

 The job is executing normally.
 

ENABLED = 1;

PAUSED

public static final Job.State PAUSED

 The job is paused by the user. It will not execute. A user can
 intentionally pause the job using
 [PauseJobRequest][google.cloud.scheduler.v1.PauseJobRequest].
 

PAUSED = 2;

DISABLED

public static final Job.State DISABLED

 The job is disabled by the system due to error. The user
 cannot directly set a job to be disabled.
 

DISABLED = 3;

UPDATE_FAILED

public static final Job.State UPDATE_FAILED

 The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]
 operation. To recover a job from this state, retry
 [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] until a successful response is received.
 

UPDATE_FAILED = 4;

UNRECOGNIZED

public static final Job.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 Unspecified state.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

ENABLED_VALUE

public static final int ENABLED_VALUE

 The job is executing normally.
 

ENABLED = 1;

See Also:

Constant Field Values

PAUSED_VALUE

public static final int PAUSED_VALUE

 The job is paused by the user. It will not execute. A user can
 intentionally pause the job using
 [PauseJobRequest][google.cloud.scheduler.v1.PauseJobRequest].
 

PAUSED = 2;

See Also:

Constant Field Values

DISABLED_VALUE

public static final int DISABLED_VALUE

 The job is disabled by the system due to error. The user
 cannot directly set a job to be disabled.
 

DISABLED = 3;

See Also:

Constant Field Values

UPDATE_FAILED_VALUE

public static final int UPDATE_FAILED_VALUE

 The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]
 operation. To recover a job from this state, retry
 [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] until a successful response is received.
 

UPDATE_FAILED = 4;

See Also:

Constant Field Values

Method Detail

values

public static Job.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 (Job.State c : Job.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 Job.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 Job.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 Job.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<Job.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 Job.State valueOf(Descriptors.EnumValueDescriptor desc)