Package org.apache.beam.sdk

Enum Class PipelineResult.State

java.lang.Object

java.lang.Enum<PipelineResult.State>

org.apache.beam.sdk.PipelineResult.State

All Implemented Interfaces:

Serializable, Comparable<PipelineResult.State>, Constable

Enclosing interface:

PipelineResult

public static enum PipelineResult.State
extends Enum<PipelineResult.State>

Possible job states, for both completed and ongoing jobs.

When determining if a job is still running, consult the isTerminal() method rather than inspecting the precise state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The job has been explicitly cancelled.
DONE	The job has successfully completed.
FAILED	The job has failed.
RUNNING	The job is currently running.
STOPPED	The job has been paused, or has not yet started.
UNKNOWN	The job state was not specified or unknown to a runner.
UNRECOGNIZED	The job state reported by a runner cannot be interpreted by the SDK.
UPDATED	The job has been updated.

Method Summary

Modifier and Type	Method	Description
final boolean	hasReplacementJob()
final boolean	isTerminal()
static PipelineResult.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PipelineResult.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final PipelineResult.State UNKNOWN

The job state was not specified or unknown to a runner.

STOPPED

public static final PipelineResult.State STOPPED

The job has been paused, or has not yet started.

RUNNING

public static final PipelineResult.State RUNNING

The job is currently running.

DONE

public static final PipelineResult.State DONE

The job has successfully completed.

FAILED

public static final PipelineResult.State FAILED

The job has failed.

CANCELLED

public static final PipelineResult.State CANCELLED

The job has been explicitly cancelled.

UPDATED

public static final PipelineResult.State UPDATED

The job has been updated.

UNRECOGNIZED

public static final PipelineResult.State UNRECOGNIZED

The job state reported by a runner cannot be interpreted by the SDK.

Method Details

values

public static PipelineResult.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PipelineResult.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isTerminal

public final boolean isTerminal()

Returns:

true if the job state can no longer complete work.

hasReplacementJob

public final boolean hasReplacementJob()

Returns:

true if this job state indicates that a replacement job exists.