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

Class Deployment

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<DeploymentProperties>

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

public class Deployment
extends RootEntityPropertiesBuilder<DeploymentProperties>

Represents a deployment project.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
Deployment(PlanIdentifier plan, String name) Specifies a deployment project.

Method Summary

Modifier and Type	Method and Description
protected DeploymentProperties	build()
Deployment	description(String description) Sets the deployment description.
Deployment	environments(Environment... environments) Adds the environments to the end of environments list.
String	getName()
BambooOidProperties	getOid()
String	humanReadableId() Entity type and id representation that is shown to human.
String	humanReadableType() Entity type that is shown to human.
Deployment	name(String name) Sets the deployment name.
Deployment	oid(BambooOid oid) Sets the deployments's oid.
Deployment	oid(String oid) Sets the deployments's oid.
Deployment	releaseNaming(ReleaseNaming releaseNaming)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

Deployment

public Deployment(@NotNull
                  PlanIdentifier plan,
                  @NotNull
                  String name)

Specifies a deployment project.

Parameters:

plan - plan that serves as source of artifacts and variables for this deployment project

name - name of the project

Method Detail

name

public Deployment name(@NotNull
                       String name)
                throws PropertiesValidationException

Sets the deployment name.

Throws:

PropertiesValidationException

oid

public Deployment oid(@Nullable
                      String oid)
               throws PropertiesValidationException

Sets the deployments's oid.

If set, it is used to identify the deployment project. If a deployment with specified oid does not exist, a new one is created, otherwise it is updated.

Throws:

PropertiesValidationException

oid

public Deployment oid(@Nullable
                      BambooOid oid)
               throws PropertiesValidationException

Sets the deployments's oid.

If set, it is used to identify the deployment project. If a deployment with specified oid does not exist, a new one is created, otherwise it is updated.

Throws:

PropertiesValidationException

description

public Deployment description(String description)

Sets the deployment description.

releaseNaming

public Deployment releaseNaming(@NotNull
                                ReleaseNaming releaseNaming)

environments

public Deployment environments(@NotNull
                               Environment... environments)

Adds the environments to the end of environments list. The order of environments is preserved.

build

protected DeploymentProperties build()

Specified by:

build in class EntityPropertiesBuilder<DeploymentProperties>

humanReadableType

public String humanReadableType()

Description copied from class: RootEntityPropertiesBuilder

Entity type that is shown to human.

Specified by:

humanReadableType in class RootEntityPropertiesBuilder<DeploymentProperties>

humanReadableId

public String humanReadableId()

Description copied from class: RootEntityPropertiesBuilder

Entity type and id representation that is shown to human.

Specified by:

humanReadableId in class RootEntityPropertiesBuilder<DeploymentProperties>

getOid

public BambooOidProperties getOid()

getName

public String getName()