IPipeline Interface
Represents a named collection of modules that should be executed by the engine.
IPipeline
IReadOnlyPipeline
TestPipeline
Assets
DirectoryMetadata
Content
Data
Archives
Api
Redirects
ExecutionPipeline
SearchIndex
Feeds
NamedPipelineWrapper
INamedPipeline
Inputs
AnalyzeContent
INamedPipelineWrapper
Code
Pipeline
Deployment
Sitemap

Syntax

public interface IPipeline : IReadOnlyPipeline

Remarks

If the pipeline implements IDisposable, System.IDisposable.Dispose will be called when the engine is disposed (I.e., on application exit).

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