com.sdl.delivery.deployer.api.processing.pipeline

Enum Status

java.lang.Object

java.lang.Enum<Status>

com.sdl.delivery.deployer.api.processing.pipeline.Status

All Implemented Interfaces:

Serializable, Comparable<Status>

public enum Status
extends Enum<Status>

It represents a processing status that can be assigned to any processing unit. By processing unit it could be the following items:

• The overall 'Deployment Execution' for a given 'Deployment Data Package'.
• One specific 'Deployment Pipeline'.
• One specific 'Executable Step' from a given 'Deployment Pipeline'.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Status when the processing unit has failed.
IN_PROGRESS Status when the processing unit is in progress.
NOT_STARTED Status when the processing unit has not been started yet.
PAUSED Status when the processing unit has been paused.
PENDING_REMOVAL Status when the removal process started.
SUCCESS Status when the processing unit has finished successfully.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_STARTED

public static final Status NOT_STARTED

Status when the processing unit has not been started yet.

IN_PROGRESS

public static final Status IN_PROGRESS

Status when the processing unit is in progress.

PAUSED

public static final Status PAUSED

Status when the processing unit has been paused.

SUCCESS

public static final Status SUCCESS

Status when the processing unit has finished successfully.

FAILED

public static final Status FAILED

Status when the processing unit has failed.

PENDING_REMOVAL

public static final Status PENDING_REMOVAL

Status when the removal process started.

Method Detail

values

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

Returns:

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

valueOf

public static Status 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 name

NullPointerException - if the argument is null