Pipeline Class
A base pipeline class.
Pipeline
object
IPipeline
IReadOnlyPipeline
Assets
DirectoryMetadata
Content
Data
Archives
Api
Redirects
SearchIndex
Feeds
Inputs
AnalyzeContent
Code
Deployment
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