Stages (jenkins-library 1.4.0 API)

jenkins_shared_library.pipelines.base.Stages

Create the various stages of a pipeline.

Example:

     Stages stages = new Stages()

     // Add some stages
     // Your stages should be filled out, just using the map stage constructor
     // here.
     stages.add(name: "Stage 1")
     stages.add(name: "Stage 2")

     // Execute the stages
     stages.execute()

     // Stage 1 will be executed
     // then Stage 2 will be executed

Properties Summary

Properties
Type	Name and description
`Stage`	`firstFailingStage`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Stages`	`add(Stage stage)` Add a stage to be executed.
	`void`	`execute()` Executes the pipeline stages in the order that they were added.
	`Stage`	`getFirstFailingStage()` Get the first failing stage of the pipeline.
	`Stage`	`getFirstStageToExecute()` Get the first stage of the pipeline.
	`Stage`	`getStage(java.lang.String stageName)` Gets a stage from the pipeline by name.
	`void`	`setFirstFailingStage(Stage stage)` Set the value of the first failing stage.
	`int`	`size()` Gets the number of stages added to the pipeline.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - Stage firstFailingStage
- Method Detail
  - Stages add(Stage stage)
    
    Add a stage to be executed.
    The stage will be added at the end of the list of stages to be executed.
    
    Method Chaining
    Multiple calls to the add method can be done in a single run.
```
     Stages stages = new Stages()
     stages.add(name: "Stage 1").add(name: "Stage 2")
 
```
    throws:
    StageException when adding a stage that has the same name as another stage.
    
    Parameters:
    stage - The stage to add to the pipeline.
    Returns:
    A reference to this class instance for method chaining.
  - void execute()
    
    Executes the pipeline stages in the order that they were added.
  - Stage getFirstFailingStage()
    
    Get the first failing stage of the pipeline.
    Returns:
    The first failing stage or null if there is none.
  - Stage getFirstStageToExecute()
    
    Get the first stage of the pipeline. (I.E. the first stage added with add(Stage)
    Returns:
    The first pipeline stage that is executed.
  - Stage getStage(java.lang.String stageName)
    
    Gets a stage from the pipeline by name.
    Parameters:
    stageName - The name of a stage.
    Returns:
    The stage for the given name
  - void setFirstFailingStage(Stage stage)
    
    Set the value of the first failing stage.
    If the first failing stage is set, this method will not overwrite that value. Instead it will silently pass.
    throws:
    StageException when a stage is passed that was not added with add(Stage)
    
    Parameters:
    stage - A stage that was added using add(Stage)
  - int size()
    
    Gets the number of stages added to the pipeline.
    Returns:
    The number of stages added to the pipeline.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class Stages

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

Stage firstFailingStage

Method Detail

Stages add(Stage stage)

Method Chaining

void execute()

Stage getFirstFailingStage()

Stage getFirstStageToExecute()

Stage getStage(java.lang.String stageName)

void setFirstFailingStage(Stage stage)

int size()