Enum JobScheduleState
- java.lang.Object
-
- java.lang.Enum<JobScheduleState>
-
- com.microsoft.azure.batch.protocol.models.JobScheduleState
-
- All Implemented Interfaces:
Serializable
,Comparable<JobScheduleState>
public enum JobScheduleState extends Enum<JobScheduleState>
Defines values for JobScheduleState.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACTIVE
The Job Schedule is active and will create Jobs as per its schedule.COMPLETED
The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly.DELETING
The user has requested that the Job Schedule be deleted, but the delete operation is still in progress.DISABLED
The user has disabled the Job Schedule.TERMINATING
The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JobScheduleState
fromString(String value)
Parses a serialized value to a JobScheduleState instance.String
toString()
static JobScheduleState
valueOf(String name)
Returns the enum constant of this type with the specified name.static JobScheduleState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ACTIVE
public static final JobScheduleState ACTIVE
The Job Schedule is active and will create Jobs as per its schedule.
-
COMPLETED
public static final JobScheduleState COMPLETED
The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly.
-
DISABLED
public static final JobScheduleState DISABLED
The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run.
-
TERMINATING
public static final JobScheduleState TERMINATING
The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active.
-
DELETING
public static final JobScheduleState DELETING
The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted.
-
-
Method Detail
-
values
public static JobScheduleState[] 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 (JobScheduleState c : JobScheduleState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobScheduleState 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 nameNullPointerException
- if the argument is null
-
fromString
public static JobScheduleState fromString(String value)
Parses a serialized value to a JobScheduleState instance.- Parameters:
value
- the serialized value to parse.- Returns:
- the parsed JobScheduleState object, or null if unable to parse.
-
toString
public String toString()
- Overrides:
toString
in classEnum<JobScheduleState>
-
-