Package com.google.cloud.scheduler.v1
Enum Job.State
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<Job.State>
- Enclosing class:
- Job
public static enum Job.State
extends Enum<Job.State>
implements com.google.protobuf.ProtocolMessageEnum
State of the job.Protobuf enum
google.cloud.scheduler.v1.Job.State-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe job is disabled by the system due to error.The job is executing normally.The job is paused by the user.Unspecified state.The job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] operation. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe job is disabled by the system due to error.static final intThe job is executing normally.static final intThe job is paused by the user.static final intUnspecified state.static final intThe job state resulting from a failed [CloudScheduler.UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob] operation. -
Method Summary
Modifier and TypeMethodDescriptionstatic Job.StateforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<Job.State>static Job.StatevalueOf(int value) Deprecated.static Job.StatevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static Job.StateReturns 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.
-
Enum Constant Details
-
STATE_UNSPECIFIED
Unspecified state.
STATE_UNSPECIFIED = 0; -
ENABLED
The job is executing normally.
ENABLED = 1; -
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
The job is disabled by the system due to error. The user cannot directly set a job to be disabled.
DISABLED = 3; -
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
-
-
Field Details
-
STATE_UNSPECIFIED_VALUE
public static final int STATE_UNSPECIFIED_VALUEUnspecified state.
STATE_UNSPECIFIED = 0;- See Also:
-
ENABLED_VALUE
public static final int ENABLED_VALUEThe job is executing normally.
ENABLED = 1;- See Also:
-
PAUSED_VALUE
public static final int PAUSED_VALUEThe 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:
-
DISABLED_VALUE
public static final int DISABLED_VALUEThe job is disabled by the system due to error. The user cannot directly set a job to be disabled.
DISABLED = 3;- See Also:
-
UPDATE_FAILED_VALUE
public static final int UPDATE_FAILED_VALUEThe 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:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.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:
value- 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 nameNullPointerException- if the argument is null
-
forNumber
- Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
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:
desc- 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 nameNullPointerException- if the argument is null
-