Represents a named collection of modules that should be executed by the engine.

Namespace

Implementing Types

graph BT Type["IReadOnlyPipeline"] class Type type-node Implementing0["ExecutionPipeline"]-.->Type click Implementing0 "/api/Statiq.Core/ExecutionPipeline" Implementing1["TestPipeline"]-.->Type click Implementing1 "/api/Statiq.Testing/TestPipeline" Implementing2["SearchIndex"]-.->Type click Implementing2 "/api/Statiq.Web.Pipelines/SearchIndex" Implementing3["Assets"]-.->Type click Implementing3 "/api/Statiq.Web.Pipelines/Assets" Implementing4["INamedPipeline"]-.->Type click Implementing4 "/api/Statiq.Common/INamedPipeline" Implementing5["Archives"]-.->Type click Implementing5 "/api/Statiq.Web.Pipelines/Archives" Implementing6["Content"]-.->Type click Implementing6 "/api/Statiq.Web.Pipelines/Content" Implementing7["NamedPipelineWrapper"]-.->Type click Implementing7 "/api/Statiq.Common/NamedPipelineWrapper" Implementing8["Api"]-.->Type click Implementing8 "/api/Statiq.Docs.Pipelines/Api" Implementing9["Inputs"]-.->Type click Implementing9 "/api/Statiq.Web.Pipelines/Inputs" Implementing10["Deployment"]-.->Type click Implementing10 "/api/Statiq.Web.Pipelines/Deployment" Implementing11["Sitemap"]-.->Type click Implementing11 "/api/Statiq.Web.Pipelines/Sitemap" Implementing12["Feeds"]-.->Type click Implementing12 "/api/Statiq.Web.Pipelines/Feeds" Implementing13["Code"]-.->Type click Implementing13 "/api/Statiq.Docs.Pipelines/Code" Implementing14["Pipeline"]-.->Type click Implementing14 "/api/Statiq.Core/Pipeline" Implementing15["DirectoryMetadata"]-.->Type click Implementing15 "/api/Statiq.Web.Pipelines/DirectoryMetadata" Implementing16["AnalyzeContent"]-.->Type click Implementing16 "/api/Statiq.Web.Pipelines/AnalyzeContent" Implementing17["Redirects"]-.->Type click Implementing17 "/api/Statiq.Web.Pipelines/Redirects" Implementing18["INamedPipelineWrapper"]-.->Type click Implementing18 "/api/Statiq.Common/INamedPipelineWrapper" Implementing19["Data"]-.->Type click Implementing19 "/api/Statiq.Web.Pipelines/Data" Implementing20["IPipeline"]-.->Type click Implementing20 "/api/Statiq.Common/IPipeline"

Syntax

public interface IReadOnlyPipeline

Properties

Name	Property Type	Summary
Dependencies	IReadOnlyCollection<string>	The names of pipelines this pipeline depends on.
DependencyOf	IReadOnlyCollection<string>	The names of pipelines that depend on this pipeline.
Deployment	bool	A deployment pipeline works just like other pipelines except it's `Output` phase will only execute when all other non-deployment pipelines have completed their `Output` phase (including isolated pipelines).
ExecutionPolicy	ExecutionPolicy	Indicates when the pipeline is executed.
Isolated	bool	An isolated pipeline runs immediately without any dependencies and has restrictions on accessing documents from other pipelines.

Extension Methods

Name	Value	Summary
GetAllDependencies(IExecutionState)	IEnumerable<string>	Gets all dependencies of this pipeline including `DependencyOf` declarations. From IPipelineExtensions
GetAllDependencies(IReadOnlyPipelineCollection)	IEnumerable<string>	Gets all dependencies of this pipeline including `DependencyOf` declarations. From IPipelineExtensions
ThrowIfNull<IReadOnlyPipeline>(string)	T	From GuardExtensions
ToDocument<IReadOnlyPipeline>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IReadOnlyPipeline>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IReadOnlyPipeline>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IReadOnlyPipeline>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IReadOnlyPipeline>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<IReadOnlyPipeline>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions