Package io.jenkins.plugins.pipeline.models

Class StageModel

java.lang.Object

io.jenkins.plugins.pipeline.models.AbstractModel

io.jenkins.plugins.pipeline.models.StageModel

All Implemented Interfaces:

ParsableModelInterface

public class StageModel
extends AbstractModel
implements ParsableModelInterface

Model Class for Jenkins Declarative Pipeline Stage Section

Field Summary

Fields

Modifier and Type	Field	Description
static final String	beforeAgentKey
static final String	directive
static final String	failFastKey

Constructor Summary

Constructors

Constructor

Description

StageModel(String name, Optional<StepsModel> stepsModel, Optional<AgentModel> agentModel, Optional<PostModel> postModel, Optional<ToolsModel> toolsModel, Optional<StagesModel> stagesModel, Optional<EnvironmentModel> environmentModel, Optional<ParallelModel> parallelModel, Optional<Boolean> failFast, Optional<InputModel> inputModel, Optional<WhenModel> whenModel, Optional<Boolean> beforeAgent, Optional<OptionsModel> optionsModel)

Method Summary

Modifier and Type	Method	Description
String	toGroovy()	Convert model to Jenkins Declarative Pipeline Syntax

Methods inherited from class io.jenkins.plugins.pipeline.models.AbstractModel

optionalBooleanToGroovy, optionalStringToGroovy

Methods inherited from class java.lang.Object

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

Field Details

directive

public static final String directive

See Also:

• Constant Field Values

failFastKey

public static final String failFastKey

See Also:

• Constant Field Values

beforeAgentKey

public static final String beforeAgentKey

See Also:

• Constant Field Values

Constructor Details

StageModel

public StageModel(String name,
 Optional<StepsModel> stepsModel,
 Optional<AgentModel> agentModel,
 Optional<PostModel> postModel,
 Optional<ToolsModel> toolsModel,
 Optional<StagesModel> stagesModel,
 Optional<EnvironmentModel> environmentModel,
 Optional<ParallelModel> parallelModel,
 Optional<Boolean> failFast,
 Optional<InputModel> inputModel,
 Optional<WhenModel> whenModel,
 Optional<Boolean> beforeAgent,
 Optional<OptionsModel> optionsModel)

Parameters:

name - Name of the stage

stepsModel - StepsModel

agentModel - AgentModel

postModel - PostModel

toolsModel - ToolsModel

stagesModel - StagesModel

environmentModel - EnvironmentModel

parallelModel - ParallelModel

failFast - Flag for failFast Option

inputModel - InputModel

whenModel - WhenModel

beforeAgent - Flag for beforeAgent option

optionsModel - OptionsModel

Method Details

toGroovy

public String toGroovy()

Description copied from interface: ParsableModelInterface

Convert model to Jenkins Declarative Pipeline Syntax

Specified by:

toGroovy in interface ParsableModelInterface

Returns:

Jenkins Declarative Pipeline Syntax