Share via


BatchJobScheduleState Class

public final class BatchJobScheduleState
extends ExpandableStringEnum<BatchJobScheduleState>

BatchJobScheduleState enums.

Field Summary

Modifier and Type Field and Description
static final BatchJobScheduleState ACTIVE

The Job Schedule is active and will create Jobs as per its schedule.

static final BatchJobScheduleState COMPLETED

The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly.

static final BatchJobScheduleState DELETING

The user has requested that the Job Schedule be deleted, but the delete operation is still in progress.

static final BatchJobScheduleState DISABLED

The user has disabled the Job Schedule.

static final BatchJobScheduleState 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.

Constructor Summary

Constructor Description
BatchJobScheduleState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchJobScheduleState value.

Method Summary

Modifier and Type Method and Description
static BatchJobScheduleState fromString(String name)

Creates or finds a BatchJobScheduleState from its string representation.

static Collection<BatchJobScheduleState> values()

Gets known BatchJobScheduleState values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

ACTIVE

public static final BatchJobScheduleState ACTIVE

The Job Schedule is active and will create Jobs as per its schedule.

COMPLETED

public static final BatchJobScheduleState COMPLETED

The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly.

DELETING

public static final BatchJobScheduleState 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.

DISABLED

public static final BatchJobScheduleState 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 BatchJobScheduleState 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.

Constructor Details

BatchJobScheduleState

@Deprecated
public BatchJobScheduleState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchJobScheduleState value.

Method Details

fromString

public static BatchJobScheduleState fromString(String name)

Creates or finds a BatchJobScheduleState from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchJobScheduleState.

values

public static Collection<BatchJobScheduleState> values()

Gets known BatchJobScheduleState values.

Returns:

known BatchJobScheduleState values.

Applies to