com.atlassian.bamboo.specs.api.builders.deployment

Class Environment

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<EnvironmentProperties>

com.atlassian.bamboo.specs.api.builders.deployment.Environment

public class Environment
extends EntityPropertiesBuilder<EnvironmentProperties>

Represents a deployment environment.

Constructor Summary

Constructors

Constructor and Description
Environment(String name) Specifies environment.

Method Summary

Modifier and Type	Method and Description
protected EnvironmentProperties	build()
Environment	description(String description) Sets the environment description.
Environment	dockerConfiguration(DockerConfiguration dockerConfiguration) Configure Docker for this environment.
Environment	finalTasks(Task<?,?>... finalTasks) Adds provided Tasks to the list of the final tasks executed by the environment.
Environment	notifications(Notification... notifications) Appends a notification rule to the environment.
Environment	pluginConfigurations(EnvironmentPluginConfiguration<? extends EnvironmentPluginConfigurationProperties>... pluginConfigurations) Appends plugin configuration to the environment.
Environment	requirements(Requirement... requirements) Adds custom requirements to the environment.
Environment	tasks(Task<?,?>... tasks) Adds provided Tasks to the list of tasks executed by the environment.
Environment	triggers(Trigger<?,?>... triggers) Adds triggers to this environment.
Environment	variables(Variable... variables) Adds deployment environment variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment(@NotNull
                   String name)

Specifies environment.

Parameters:

name - name of the environment.

Method Detail

description

public Environment description(String description)

Sets the environment description.

tasks

public Environment tasks(@NotNull
                         Task<?,?>... tasks)

Adds provided Tasks to the list of tasks executed by the environment.

finalTasks

public Environment finalTasks(@NotNull
                              Task<?,?>... finalTasks)

Adds provided Tasks to the list of the final tasks executed by the environment.

Final tasks for a environment are always executed, even if previous tasks in the environment failed.

triggers

public Environment triggers(@NotNull
                            Trigger<?,?>... triggers)

Adds triggers to this environment.

variables

public Environment variables(@NotNull
                             Variable... variables)

Adds deployment environment variables.

requirements

public Environment requirements(Requirement... requirements)

Adds custom requirements to the environment.

Requirements control which Bamboo agents are able to execute deployments to the environment.

notifications

public Environment notifications(@NotNull
                                 Notification... notifications)

Appends a notification rule to the environment.

dockerConfiguration

public Environment dockerConfiguration(@NotNull
                                       DockerConfiguration dockerConfiguration)

Configure Docker for this environment.

See Also:

DockerConfiguration

pluginConfigurations

public Environment pluginConfigurations(@NotNull
                                        EnvironmentPluginConfiguration<? extends EnvironmentPluginConfigurationProperties>... pluginConfigurations)

Appends plugin configuration to the environment. If the same plugin is specified second time, its configuration is overwritten.

build

protected EnvironmentProperties build()

Specified by:

build in class EntityPropertiesBuilder<EnvironmentProperties>