OctopusDeployCommonToolSettings Class

Summary

Contains the common settings used by all commands in OctopusDeployTool<TSettings>.
Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
Derived Types
graph BT Type-->Base0["OctopusDeployToolSettings"] click Base0 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployToolSettings" Base0-->Base1["ToolSettings"] click Base1 "/api/Cake.Core.Tooling/ToolSettings" Base1-->Base2["object"] Type["OctopusDeployCommonToolSettings"] class Type type-node Derived0["CreateReleaseSettings"]-->Type click Derived0 "/api/Cake.Common.Tools.OctopusDeploy/CreateReleaseSettings" Derived1["OctopusDeployReleaseDeploymentSettings"]-->Type click Derived1 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployReleaseDeploymentSettings" Derived2["OctopusDeployPromoteReleaseSettings"]-->Type click Derived2 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployPromoteReleaseSettings" Derived3["OctopusDeploymentQuerySettings"]-->Type click Derived3 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeploymentQuerySettings" Derived4["OctopusPushSettings"]-->Type click Derived4 "/api/Cake.Common.Tools.OctopusDeploy/OctopusPushSettings"

Syntax

public abstract class OctopusDeployCommonToolSettings : OctopusDeployToolSettings

Properties

Name Value Summary
ApiKey string
Gets or sets the user's API key.
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
ConfigurationFile FilePath
Gets or sets the text file of default values.
EnableDebugLogging bool
Gets or sets a value indicating whether the enable debug logging flag is set.
EnableServiceMessages bool
Gets or sets a value indicating whether the enable service messages flag is set.
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
IgnoreSslErrors bool
Gets or sets a value indicating whether the ignore SSL errors flag is set.
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
Password string
Gets or sets the password to use when authenticating with the server.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
Server string
Gets or sets the octopus server url.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
Space string
Gets or sets the name of a space within which this command will be executed. The default space will be used if it is omitted.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Username string
Gets or sets the username to use when authenticating with the server.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<OctopusDeployCommonToolSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<OctopusDeployCommonToolSettings>(OctopusDeployCommonToolSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<OctopusDeployCommonToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<OctopusDeployCommonToolSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<OctopusDeployCommonToolSettings>(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<OctopusDeployCommonToolSettings>(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
Requires the Cake.Issues addin
WithArgumentCustomization<OctopusDeployCommonToolSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<OctopusDeployCommonToolSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<OctopusDeployCommonToolSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<OctopusDeployCommonToolSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<OctopusDeployCommonToolSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<OctopusDeployCommonToolSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<OctopusDeployCommonToolSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<OctopusDeployCommonToolSettings>(FilePath) T
Sets the tool path.
WithToolSettings<OctopusDeployCommonToolSettings>(Action<OctopusDeployCommonToolSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<OctopusDeployCommonToolSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<OctopusDeployCommonToolSettings>(DirectoryPath) T
Sets the tool working directory.