Pipeline Class
A base pipeline class.
graph BT Type-->Base0["object"] Type-.->Interface0["IPipeline"] click Interface0 "/api/Statiq.Common/IPipeline" Type-.->Interface1["IReadOnlyPipeline"] click Interface1 "/api/Statiq.Common/IReadOnlyPipeline" Type["Pipeline"] class Type type-node Derived0["Assets"]-->Type click Derived0 "/api/Statiq.Web.Pipelines/Assets" Derived1["DirectoryMetadata"]-->Type click Derived1 "/api/Statiq.Web.Pipelines/DirectoryMetadata" Derived2["Content"]-->Type click Derived2 "/api/Statiq.Web.Pipelines/Content" Derived3["Data"]-->Type click Derived3 "/api/Statiq.Web.Pipelines/Data" Derived4["Archives"]-->Type click Derived4 "/api/Statiq.Web.Pipelines/Archives" Derived5["Api"]-->Type click Derived5 "/api/Statiq.Docs.Pipelines/Api" Derived6["Redirects"]-->Type click Derived6 "/api/Statiq.Web.Pipelines/Redirects" Derived7["SearchIndex"]-->Type click Derived7 "/api/Statiq.Web.Pipelines/SearchIndex" Derived8["Feeds"]-->Type click Derived8 "/api/Statiq.Web.Pipelines/Feeds" Derived9["Inputs"]-->Type click Derived9 "/api/Statiq.Web.Pipelines/Inputs" Derived10["AnalyzeContent"]-->Type click Derived10 "/api/Statiq.Web.Pipelines/AnalyzeContent" Derived11["Code"]-->Type click Derived11 "/api/Statiq.Docs.Pipelines/Code" Derived12["Deployment"]-->Type click Derived12 "/api/Statiq.Web.Pipelines/Deployment" Derived13["Sitemap"]-->Type click Derived13 "/api/Statiq.Web.Pipelines/Sitemap"

Syntax

public class Pipeline : IPipeline, IReadOnlyPipeline

Remarks

Use the derived constructor to initialize the phases and other properties.

Properties

Name Property Type Summary
Dependencies HashSet<string>
DependencyOf HashSet<string>
Deployment bool
ExecutionPolicy ExecutionPolicy
InputModules ModuleList
Modules that will execute during the input phase.
Isolated bool
OutputModules ModuleList
Modules that will execute during the output phase.
PostProcessHasDependencies bool
PostProcessModules ModuleList
Modules that will execute during the post-process phase.
ProcessModules ModuleList
Modules that will execute during the process phase.

Extension Methods

Name Value Summary
AlwaysExecute<Pipeline>() TPipeline
AsDependencyOf<Pipeline>(IEnumerable<string>) TPipeline
AsDependencyOf<Pipeline>(string[]) TPipeline
AsDeployment<Pipeline>(bool) TPipeline
AsIsolated<Pipeline>(bool) TPipeline
AsPostProcessHasDependencies<Pipeline>(bool) TPipeline
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<Pipeline>() TPipeline
NormallyExecute<Pipeline>() TPipeline
ThrowIfNull<Pipeline>(string) T
ToDocument<Pipeline>(IContentProvider) IDocument
ToDocument<Pipeline>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<Pipeline>(NormalizedPath, IContentProvider) IDocument
ToDocument<Pipeline>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<Pipeline>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<Pipeline>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
WithDependencies<Pipeline>(IEnumerable<string>) TPipeline
WithDependencies<Pipeline>(string[]) TPipeline
WithExecutionPolicy<Pipeline>(ExecutionPolicy) TPipeline
WithInputConfig<Pipeline>(Config<object>) TPipeline
WithInputModules<Pipeline>(IEnumerable<IModule>) TPipeline
WithInputModules<Pipeline>(IModule[]) TPipeline
WithOutputConfig<Pipeline>(Config<object>) TPipeline
WithOutputModules<Pipeline>(IEnumerable<IModule>) TPipeline
WithOutputModules<Pipeline>(IModule[]) TPipeline
WithPostProcessConfig<Pipeline>(Config<object>) TPipeline
WithPostProcessModules<Pipeline>(IEnumerable<IModule>) TPipeline
WithPostProcessModules<Pipeline>(IModule[]) TPipeline
WithProcessConfig<Pipeline>(Config<object>) TPipeline
WithProcessModules<Pipeline>(IEnumerable<IModule>) TPipeline
WithProcessModules<Pipeline>(IModule[]) TPipeline