Common
A library of common classes.
Public Member Functions | Properties | List of all members
Pipeline Class Reference

A class for chaining multiple IPipelineStep together. More...

Public Member Functions

 Pipeline (params IPipelineStep[] steps)
 Initializes a new pipeline. More...
 
PipelineResults Run (Dictionary< string, object > inputs, Action< string > logger=null, CancellationToken cancellationToken=default)
 Invokes all steps of the pipeline and returns the results. More...
 
Task< PipelineResults > RunAsync (Dictionary< string, object > inputs, Action< string > logger=null, CancellationToken cancellationToken=default)
 Runs the pipeline asynchonously. More...
 

Properties

List< IPipelineStep > Steps = new List<IPipelineStep>() [getprivate set]
 A list of pipeline steps. More...
 

Detailed Description

A class for chaining multiple IPipelineStep together.

Definition at line 11 of file Pipeline.cs.

Constructor & Destructor Documentation

◆ Pipeline()

Pipeline ( params IPipelineStep[]  steps)

Initializes a new pipeline.

Parameters
stepsThe pipeline steps.

Definition at line 22 of file Pipeline.cs.

Member Function Documentation

◆ Run()

PipelineResults Run ( Dictionary< string, object >  inputs,
Action< string >  logger = null,
CancellationToken  cancellationToken = default 
)

Invokes all steps of the pipeline and returns the results.

Parameters
inputsA dictionary of pipeline inputs.
loggerA logging action. Ignored if null.
cancellationTokenThe cancellation token.

Definition at line 33 of file Pipeline.cs.

◆ RunAsync()

Task< PipelineResults > RunAsync ( Dictionary< string, object >  inputs,
Action< string >  logger = null,
CancellationToken  cancellationToken = default 
)

Runs the pipeline asynchonously.

Parameters
inputsA dictionary of pipeline inputs.
loggerA logging action. Ignored if null.
cancellationTokenThe cancellation token.

Definition at line 64 of file Pipeline.cs.

Property Documentation

◆ Steps

List<IPipelineStep> Steps = new List<IPipelineStep>()
getprivate set

A list of pipeline steps.

Definition at line 16 of file Pipeline.cs.

The documentation for this class was generated from the following file: