Class StepAbstract

A generic Step which can be added to a Pipeline

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

Hierarchy (view full)

Implements

Constructors

constructor

Properties

dependencyFileSets id isSource

Accessors

consumedStackOutputs dependencies primaryOutput

Methods

addDependencyFileSet addStepDependency configurePrimaryOutput discoverReferencedOutputs toString sequence

Constructors

constructor

  • new Step(id): Step

  • Parameters

    • id: string

      Identifier for this step

    Returns Step

Properties

ReadonlydependencyFileSets

dependencyFileSets: FileSet[]

The list of FileSets consumed by this Step

Readonlyid

id: string

Identifier for this step

ReadonlyisSource

isSource: boolean

Whether or not this is a Source step

What it means to be a Source step depends on the engine.

Accessors

consumedStackOutputs

dependencies

  • get dependencies(): Step[]

  • Return the steps this step depends on, based on the FileSets it requires

    Returns Step[]

primaryOutput

  • get primaryOutput(): undefined | FileSet

  • The primary FileSet produced by this Step

    Not all steps produce an output FileSet--if they do you can substitute the Step object for the FileSet object.

    Returns undefined | FileSet

Methods

ProtectedaddDependencyFileSet

  • addDependencyFileSet(fs): void

  • Add an additional FileSet to the set of file sets required by this step

    This will lead to a dependency on the producer of that file set.

    Parameters

    Returns void

addStepDependency

  • addStepDependency(step): void

  • Add a dependency on another step.

    Parameters

    Returns void

ProtectedconfigurePrimaryOutput

  • configurePrimaryOutput(fs): void

  • Configure the given FileSet as the primary output of this step

    Parameters

    Returns void

ProtecteddiscoverReferencedOutputs

  • discoverReferencedOutputs(structure): void

  • Crawl the given structure for references to StepOutputs and add dependencies on all steps found

    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.

    Parameters

    • structure: any

    Returns void

toString

  • toString(): string

  • Return a string representation of this Step

    Returns string

Staticsequence

  • sequence(steps): Step[]

  • Define a sequence of steps to be executed in order.

    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).

    Parameters

    Returns Step[]

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods