| AfterExecution(IExecutionContext, ExecutionOutputs) |
void |
Called after each module execution.
|
| AfterExecutionAsync(IExecutionContext, ExecutionOutputs) |
Task |
Called after each module execution.
|
| AsBackground(bool, bool) |
StartProcess |
Starts the process and leaves it running in the background.
|
| BeforeExecution(IExecutionContext) |
void |
Called before each module execution.
|
| BeforeExecutionAsync(IExecutionContext) |
Task |
Called before each module execution.
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, Task<TValue>>) |
MultiConfigModuleBase |
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, TValue>) |
MultiConfigModuleBase |
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, Task<TValue>>) |
MultiConfigModuleBase |
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, TValue>) |
MultiConfigModuleBase |
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, Task<TValue>>) |
MultiConfigModuleBase |
|
| CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, TValue>) |
MultiConfigModuleBase |
|
| ContinueOnError(Config<bool>) |
StartProcess |
Toggles throwing an exception if the process exits with a non-zero exit code.
|
| Dispose() |
void |
|
| 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.
|
| ExecuteConfig(IDocument, IExecutionContext, IMetadata) |
IEnumerable<IDocument> |
|
| ExecuteConfigAsync(IDocument, IExecutionContext, IMetadata) |
Task<IEnumerable<IDocument>> |
Executes the module for each input document.
If there aren't any input documents and the config delegate doesn't require documents,
this will be called once with a null input.
|
| ExecuteContextAsync(IExecutionContext) |
Task<IEnumerable<IDocument>> |
Executes the module once for all input documents.
|
| ExecuteInputAsync(IDocument, IExecutionContext) |
Task<IEnumerable<IDocument>> |
Executes the module.
|
| Finally(IExecutionContext) |
void |
Called after each module execution, even if an exception is thrown during execution.
|
| FinallyAsync(IExecutionContext) |
Task |
Called after each module execution, even if an exception is thrown during execution.
|
| GetConfig(string) |
IConfig |
Gets the config for a given key.
|
| GetConfig<TValue>(string) |
Config<TValue> |
Gets the config for a given key cast to a specific config value.
|
| HideArguments(Config<bool>) |
StartProcess |
Toggles whether to hide the arguments list when logging the process command.
|
| KeepContent(Config<bool>) |
StartProcess |
Keeps the existing document content instead of replacing it with the process output.
|
| LogErrors(Config<bool>) |
StartProcess |
Toggles whether to log error process output as error messages.
|
| LogOutput(Config<bool>) |
StartProcess |
Toggles whether to log standard process output as information messages.
|
| OnlyOnce(bool) |
StartProcess |
Only starts the process on the first module execution.
|
| SetConfig(string, IConfig) |
MultiConfigModuleBase |
Sets the config for a given key.
|
| TryGetConfig(string, IConfig) |
bool |
|
| WithArgument(Config<StartProcessArgument>) |
StartProcess |
Appends an argument to the command.
|
| WithArgument(Config<string>, bool) |
StartProcess |
Appends an argument to the command.
|
| WithArgument(Config<string>, Config<string>, bool) |
StartProcess |
Appends an argument to the command.
|
| WithArguments(Config<IReadOnlyList<StartProcessArgument>>) |
StartProcess |
Appends arguments to the command.
|
| WithEnvironmentVariable(Config<KeyValuePair<string, string>>) |
StartProcess |
Sets a process-specific environment variable.
|
| WithEnvironmentVariables(Config<IEnumerable<KeyValuePair<string, string>>>) |
StartProcess |
Sets process-specific environment variables.
|
| WithErrorExitCode(Func<int, bool>) |
StartProcess |
Provides a function that determines if the exit code from the process was an error.
|
| WithTimeout(Config<int>) |
StartProcess |
Sets a timeout in milliseconds before the process will be terminated.
|
| WithWorkingDirectory(Config<string>) |
StartProcess |
Sets the working directory to use for the process relative to the root path.
|