OctopusDeployToolSettings Class

Summary

Base class for tool settings used by all commands in OctopusDeployTool<TSettings>.
Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
Derived Types
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["OctopusDeployToolSettings"] class Type type-node Derived0["OctopusPackSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.OctopusDeploy/OctopusPackSettings" Derived1["OctopusDeployCommonToolSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployCommonToolSettings"

Syntax

public abstract class OctopusDeployToolSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
HandleExitCode Func<int, bool>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.

If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.

If the delegate returns true then no exception is thrown.

This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value.

Inherited from ToolSettings
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<OctopusDeployToolSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<OctopusDeployToolSettings>(OctopusDeployToolSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<OctopusDeployToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<OctopusDeployToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<OctopusDeployToolSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<OctopusDeployToolSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
WithArgumentCustomization<OctopusDeployToolSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<OctopusDeployToolSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<OctopusDeployToolSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<OctopusDeployToolSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<OctopusDeployToolSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<OctopusDeployToolSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<OctopusDeployToolSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<OctopusDeployToolSettings>(FilePath) T
Sets the tool path.
WithToolSettings<OctopusDeployToolSettings>(Action<OctopusDeployToolSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<OctopusDeployToolSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<OctopusDeployToolSettings>(DirectoryPath) T
Sets the tool working directory.