Package com.atlassian.bitbucket.jenkins.internal.model.deployment

Enum DeploymentState

java.lang.Object

java.lang.Enum<DeploymentState>

com.atlassian.bitbucket.jenkins.internal.model.deployment.DeploymentState

All Implemented Interfaces:

Serializable, Comparable<DeploymentState>

public enum DeploymentState
extends Enum<DeploymentState>

The possible states of a deployment.

Since:

3.1.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The deployment started, but was stopped part way through.
FAILED	The deployment failed to complete.
IN_PROGRESS	The deployment is currently in progress.
PENDING	The deployment has been scheduled, but has not started.
ROLLED_BACK	The commit is no longer deployed to the the environment.
SUCCESSFUL	The deployment was successful.
UNKNOWN	The state of the deployment is not known.

Method Summary

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

PENDING

public static final DeploymentState PENDING

The deployment has been scheduled, but has not started.

IN_PROGRESS

public static final DeploymentState IN_PROGRESS

The deployment is currently in progress.

CANCELLED

public static final DeploymentState CANCELLED

The deployment started, but was stopped part way through.

FAILED

public static final DeploymentState FAILED

The deployment failed to complete.

ROLLED_BACK

public static final DeploymentState ROLLED_BACK

The commit is no longer deployed to the the environment.

SUCCESSFUL

public static final DeploymentState SUCCESSFUL

The deployment was successful.

UNKNOWN

public static final DeploymentState UNKNOWN

The state of the deployment is not known.

Method Detail

values

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

Returns:

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

valueOf

public static DeploymentState 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

getDescriptiveText

public String getDescriptiveText(String jobName,
                                 String environmentName)