Package com.veeva.vault.sdk.api.job

Enum Class TaskState

java.lang.Object

java.lang.Enum<TaskState>

com.veeva.vault.sdk.api.job.TaskState

All Implemented Interfaces:

Serializable, Comparable<TaskState>, Constable

public enum TaskState
extends Enum<TaskState>

Valid values for defining the final state of a TaskOutput.

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
ERRORS_ENCOUNTERED	The task finished its work but encountered one or more errors.
FAILED_TO_RUN	The task was not executed, often due to a job cancellation or a preceding critical failure.
SUCCESS	The task completed all its work without any errors.

Method Summary

Modifier and Type	Method	Description
static TaskState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaskState[]	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

SUCCESS

public static final TaskState SUCCESS

The task completed all its work without any errors.

ERRORS_ENCOUNTERED

public static final TaskState ERRORS_ENCOUNTERED

The task finished its work but encountered one or more errors.

FAILED_TO_RUN

public static final TaskState FAILED_TO_RUN

The task was not executed, often due to a job cancellation or a preceding critical failure.

Method Details

values

public static TaskState[] 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 TaskState 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