com.atlassian.bamboo.rest.model.deployments.environments

Class RestEnvironment

java.lang.Object

com.atlassian.bamboo.rest.model.deployments.environments.RestEnvironment

All Implemented Interfaces:

BambooIdProvider, Environment, InternalEnvironment, TaskContainer, Triggerable, DescriptionProvider, NameProvider

public class RestEnvironment
extends Object
implements Environment

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestEnvironment()
	RestEnvironment(Environment environment)

Method Summary

Modifier and Type	Method and Description
ConfigurationState	getConfigurationState()
long	getDeploymentProjectId()
String	getDescription()
long	getId()
RestKey	getKey() Key representing this environment.
String	getName()
RestOperations	getOperations() Operations object describing detailed permissions for environment
int	getPosition()
List<TaskDefinition>	getTaskDefinitions()
List<TriggerDefinition>	getTriggerDefinitions()
boolean	isSuspended()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestEnvironment

protected RestEnvironment()

RestEnvironment

public RestEnvironment(@NotNull
                       Environment environment)

Method Detail

getId

public long getId()

Specified by:

getId in interface BambooIdProvider

Specified by:

getId in interface InternalEnvironment

Returns:

unique identifier (in this case from database)

getKey

@NotNull
public RestKey getKey()

Description copied from interface: InternalEnvironment

Key representing this environment. Keys have much less significance in deployments than in plans. Please consider using InternalEnvironment.getId() instead.

Specified by:

getKey in interface InternalEnvironment

Returns:

key of this environment.

getName

@NotNull
public String getName()

Specified by:

getName in interface InternalEnvironment

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

User friendly shortish name for this environment. Must be unique within a deployment project

getDescription

public String getDescription()

Specified by:

getDescription in interface InternalEnvironment

Specified by:

getDescription in interface DescriptionProvider

Returns:

Optional, longer description of the environment

getTaskDefinitions

@NotNull
public List<TaskDefinition> getTaskDefinitions()

Specified by:

getTaskDefinitions in interface Environment

Specified by:

getTaskDefinitions in interface TaskContainer

Returns:

an ordered list of taskDefinitions for this environment.

getTriggerDefinitions

@NotNull
public List<TriggerDefinition> getTriggerDefinitions()

Specified by:

getTriggerDefinitions in interface Triggerable

Returns:

immutable list of all triggers defined for this object

getConfigurationState

public ConfigurationState getConfigurationState()

Specified by:

getConfigurationState in interface InternalEnvironment

Returns:

Enum representing how completed the configuration of this environments is.

isSuspended

public boolean isSuspended()

Specified by:

isSuspended in interface Triggerable

Returns:

true if automatic triggering is switched off for this object

getDeploymentProjectId

public long getDeploymentProjectId()

Specified by:

getDeploymentProjectId in interface InternalEnvironment

Returns:

id of the DeploymentProject which is owner of this environment

getOperations

public RestOperations getOperations()

Description copied from interface: Environment

Operations object describing detailed permissions for environment

Specified by:

getOperations in interface Environment

Returns:

getPosition

public int getPosition()

Specified by:

getPosition in interface InternalEnvironment

Returns:

position of this environment in deployment project's environment list.