org.apache.samza.rest.model

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

org.apache.samza.rest.model.JobStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobStatus>

public enum JobStatus
extends java.lang.Enum<JobStatus>

The abstract status of the job, irrespective of the status in any underlying cluster management system (e.g. YARN). This status is the client view of the job status.

Enum Constant Summary

Enum Constants

Enum Constant and Description
STARTED Job has been started.
STARTING Job is in the process of starting but is not yet running.
STOPPED Job has been stopped.
UNKNOWN Job status is unknown.

Method Summary

Modifier and Type	Method and Description
boolean	hasBeenStarted()
java.lang.String	toString()
static JobStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STARTING

public static final JobStatus STARTING

Job is in the process of starting but is not yet running.

STARTED

public static final JobStatus STARTED

Job has been started.

STOPPED

public static final JobStatus STOPPED

Job has been stopped.

UNKNOWN

public static final JobStatus UNKNOWN

Job status is unknown.

Method Detail

values

public static JobStatus[] 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 (JobStatus c : JobStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static JobStatus valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JobStatus>

hasBeenStarted

public boolean hasBeenStarted()