Package com.atlassian.bamboo.specs.api.builders.plan

Class Stage

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.plan.Stage

public class Stage
extends EntityPropertiesBuilder<StageProperties>

Represents a stage within Bamboo plan.

Stages organize plan into parts that are executed sequentially.

Constructor Summary

Constructors

Constructor	Description
Stage(@NotNull Stage copy)
Stage(@NotNull String name)	Specify a stage with a given name.

Method Summary

Modifier and Type	Method	Description
protected StageProperties	build()
Stage	description(@Nullable String description)	Sets a stage description.
Stage	finalStage(boolean isFinal)	Specifies if stage is a final stage.
Stage	jobs(@NotNull Job... jobs)	Adds Jobs to the stage.
Stage	manual(boolean isManual)	Specifies if stage is a manual stage.
Stage	name(@NotNull String name)	Sets a stage's name.

Methods inherited from class java.lang.Object

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

Constructor Details

Stage

public Stage(@NotNull
 @NotNull Stage copy)

Stage

public Stage(@NotNull
 @NotNull String name)
      throws PropertiesValidationException

Specify a stage with a given name. In the absence of oid, the name is used to identify the stage. If the stage with given name does not exist, a new one is created, otherwise existing one is updated.

The name should be unique in scope of a plan it is defined in.

Throws:

PropertiesValidationException

Method Details

name

public Stage name(@NotNull
 @NotNull String name)
           throws PropertiesValidationException

Sets a stage's name. In the absence of oid, the name is used to identify the stage. If the stage with given name does not exist, a new one is created, otherwise existing one is updated.

The name should be unique in scope of a plan it is defined in.

Throws:

PropertiesValidationException

description

public Stage description(@Nullable
 @Nullable String description)
                  throws PropertiesValidationException

Sets a stage description.

Throws:

PropertiesValidationException

manual

public Stage manual(boolean isManual)
             throws PropertiesValidationException

Specifies if stage is a manual stage.

If stage is a manual stage, Bamboo waits for user confirmation before starting it.

Throws:

PropertiesValidationException

finalStage

public Stage finalStage(boolean isFinal)
                 throws PropertiesValidationException

Specifies if stage is a final stage.

If stage is a final stage, it will be executed even if previous stages failed. Note however that placing manual stage before a final stage will prevent the final stage from executing until a user confirms execution of the manual stage.

Throws:

PropertiesValidationException

jobs

public Stage jobs(@NotNull
 @NotNull Job... jobs)

Adds Jobs to the stage.

build

protected StageProperties build()
                         throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<StageProperties>

Throws:

PropertiesValidationException