ExecutionPipeline Class
A base pipeline that runs code for each execution phase.
Namespace
Statiq.Core
Interfaces
Base Types
graph BT Type-->Base0["Module"] click Base0 "/api/Statiq.Common/Module" Base0-->Base1["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IPipeline"] click Interface1 "/api/Statiq.Common/IPipeline" Type-.->Interface2["IReadOnlyPipeline"] click Interface2 "/api/Statiq.Common/IReadOnlyPipeline" Type["ExecutionPipeline"] class Type type-node

Syntax

public abstract class ExecutionPipeline : Module, IModule, IPipeline, IReadOnlyPipeline

Constructors

Name Summary
ExecutionPipeline()

Properties

Name Property Type Summary
Dependencies HashSet<string>
DependencyOf HashSet<string>
Deployment bool
ExecutionPolicy ExecutionPolicy
Isolated bool
PostProcessHasDependencies bool

Methods

Name Return Value Summary
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
ExecuteAsync(IExecutionContext) Task<IEnumerable<IDocument>>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module.
ExecuteInputPhaseAsync(IExecutionContext) Task<IEnumerable<IDocument>>
ExecuteOutputPhaseAsync(IExecutionContext) Task<IEnumerable<IDocument>>
ExecuteProcessPhaseAsync(IExecutionContext) Task<IEnumerable<IDocument>>
ExecuteTransformPhaseAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module

Extension Methods

Name Value Summary
AlwaysExecute<ExecutionPipeline>() TPipeline
AsDependencyOf<ExecutionPipeline>(IEnumerable<string>) TPipeline
AsDependencyOf<ExecutionPipeline>(string[]) TPipeline
AsDeployment<ExecutionPipeline>(bool) TPipeline
AsIsolated<ExecutionPipeline>(bool) TPipeline
AsPostProcessHasDependencies<ExecutionPipeline>(bool) TPipeline
ForEachDocument() ForEachDocument
GetAllDependencies(IExecutionState) IEnumerable<string>
Gets all dependencies of this pipeline including DependencyOf declarations.
GetAllDependencies(IReadOnlyPipelineCollection) IEnumerable<string>
Gets all dependencies of this pipeline including DependencyOf declarations.
ManuallyExecute<ExecutionPipeline>() TPipeline
NormallyExecute<ExecutionPipeline>() TPipeline
ThrowIfNull<ExecutionPipeline>(string) T
ToDocument<ExecutionPipeline>(IContentProvider) IDocument
ToDocument<ExecutionPipeline>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<ExecutionPipeline>(NormalizedPath, IContentProvider) IDocument
ToDocument<ExecutionPipeline>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<ExecutionPipeline>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<ExecutionPipeline>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
WithDependencies<ExecutionPipeline>(IEnumerable<string>) TPipeline
WithDependencies<ExecutionPipeline>(string[]) TPipeline
WithExecutionPolicy<ExecutionPipeline>(ExecutionPolicy) TPipeline
WithInputConfig<ExecutionPipeline>(Config<object>) TPipeline
WithInputModules<ExecutionPipeline>(IEnumerable<IModule>) TPipeline
WithInputModules<ExecutionPipeline>(IModule[]) TPipeline
WithOutputConfig<ExecutionPipeline>(Config<object>) TPipeline
WithOutputModules<ExecutionPipeline>(IEnumerable<IModule>) TPipeline
WithOutputModules<ExecutionPipeline>(IModule[]) TPipeline
WithPostProcessConfig<ExecutionPipeline>(Config<object>) TPipeline
WithPostProcessModules<ExecutionPipeline>(IEnumerable<IModule>) TPipeline
WithPostProcessModules<ExecutionPipeline>(IModule[]) TPipeline
WithProcessConfig<ExecutionPipeline>(Config<object>) TPipeline
WithProcessModules<ExecutionPipeline>(IEnumerable<IModule>) TPipeline
WithProcessModules<ExecutionPipeline>(IModule[]) TPipeline