@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:37.760Z") public abstract class Step extends software.amazon.jsii.JsiiObject implements IFileSetProducer
Steps can be used to add Sources, Build Actions and Validations to your pipeline.
This class is abstract. See specific subclasses of Step for useful steps to add to your Pipeline
Example:
// Step A will depend on step B and step B will depend on step C Step[] orderedSteps = Step.sequence(List.of( new ManualApprovalStep("A"), new ManualApprovalStep("B"), new ManualApprovalStep("C")));
IFileSetProducer.Jsii$Default
Modifier | Constructor and Description |
---|---|
protected |
Step(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Step(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected void |
addDependencyFileSet(FileSet fs)
Add an additional FileSet to the set of file sets required by this step.
|
void |
addStepDependency(Step step)
Add a dependency on another step.
|
protected void |
configurePrimaryOutput(FileSet fs)
Configure the given FileSet as the primary output of this step.
|
protected void |
discoverReferencedOutputs(java.lang.Object structure)
Crawl the given structure for references to StepOutputs and add dependencies on all steps found.
|
java.util.List<Step> |
getDependencies()
Return the steps this step depends on, based on the FileSets it requires.
|
java.util.List<FileSet> |
getDependencyFileSets()
The list of FileSets consumed by this Step.
|
java.lang.String |
getId()
Identifier for this step.
|
java.lang.Boolean |
getIsSource()
Whether or not this is a Source step.
|
FileSet |
getPrimaryOutput()
The primary FileSet produced by this Step.
|
static java.util.List<Step> |
sequence(java.util.List<? extends Step> steps)
Define a sequence of steps to be executed in order.
|
java.lang.String |
toString()
Return a string representation of this Step.
|
protected Step(software.amazon.jsii.JsiiObjectRef objRef)
protected Step(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public static java.util.List<Step> sequence(java.util.List<? extends Step> steps)
If you need more fine-grained step ordering, use the addStepDependency()
API. For example, if you want secondStep
to occur after firstStep
, call
secondStep.addStepDependency(firstStep)
.
steps
- This parameter is required.protected void addDependencyFileSet(FileSet fs)
This will lead to a dependency on the producer of that file set.
fs
- This parameter is required.public void addStepDependency(Step step)
step
- This parameter is required.protected void configurePrimaryOutput(FileSet fs)
fs
- This parameter is required.protected void discoverReferencedOutputs(java.lang.Object structure)
Should be called in the constructor of subclasses based on what the user passes in as construction properties. The format of the structure passed in here does not have to correspond exactly to what gets rendered into the engine, it just needs to contain the same data.
structure
- This parameter is required.public java.lang.String toString()
public java.util.List<Step> getDependencies()
public java.util.List<FileSet> getDependencyFileSets()
public java.lang.String getId()
public java.lang.Boolean getIsSource()
What it means to be a Source step depends on the engine.
public FileSet getPrimaryOutput()
Not all steps produce an output FileSet--if they do
you can substitute the Step
object for the FileSet
object.
getPrimaryOutput
in interface IFileSetProducer