com.atlassian.bamboo.deployments.environments

Interface InternalEnvironment

All Superinterfaces:

BambooIdProvider, DescriptionProvider, NameProvider, TaskContainer, Triggerable

All Known Subinterfaces:

DecoratedEnvironment, Environment, EnvironmentStub, MutableEnvironment

All Known Implementing Classes:

DecoratedEnvironmentImpl, EnvironmentImpl, EnvironmentStubDto, EnvironmentStubImpl, EnvironmentWithConfigCounts, MutableEnvironmentImpl, RestEnvironment, RestEnvironmentWithConfigCounts

@Internal
public interface InternalEnvironment
extends BambooIdProvider, NameProvider, DescriptionProvider, Triggerable, TaskContainer

Common interface between all types of deployment environments. Defines relationship between client side objects and db objects. Though probably not useful for anything else. Be wary when adding things to this interface - be sure it makes sense in all contexts.

Method Summary

Modifier and Type	Method and Description
ConfigurationState	getConfigurationState()
long	getDeploymentProjectId()
String	getDescription()
long	getId()
DeploymentKey	getKey() Key representing this environment.
String	getName()
int	getPosition()
ImmutableRequirementSet	getRequirementSet() Return effective value of ImmutableRequirementSet, that is value that is considered when checking which agents and elastic images can deploy to this environment.

Methods inherited from interface com.atlassian.bamboo.trigger.Triggerable

getTriggerDefinitions, isSuspended

Methods inherited from interface com.atlassian.bamboo.task.TaskContainer

getTaskDefinitions

Method Detail

getId

long getId()

Specified by:

getId in interface BambooIdProvider

Returns:

unique identifier (in this case from database)

getKey

@NotNull
DeploymentKey getKey()

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

Returns:

key of this environment.

getName

@NotNull
String getName()

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

@Nullable
String getDescription()

Specified by:

getDescription in interface DescriptionProvider

Returns:

Optional, longer description of the environment

getDeploymentProjectId

long getDeploymentProjectId()

Returns:

id of the DeploymentProject which is owner of this environment

getConfigurationState

ConfigurationState getConfigurationState()

Returns:

Enum representing how completed the configuration of this environments is.

getPosition

int getPosition()

Returns:

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

getRequirementSet

@NotNull
ImmutableRequirementSet getRequirementSet()

Return effective value of ImmutableRequirementSet, that is value that is considered when checking which agents and elastic images can deploy to this environment.