DotNetToolInstallSettings Class

Summary

Contains settings used by dotnet tool install.
Namespace
Cake.Common.Tools.DotNet.Tool
Base Types
graph BT Type-->Base0["DotNetToolSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.Tool/DotNetToolSettings" Base0-->Base1["DotNetSettings"] click Base1 "/api/Cake.Common.Tools.DotNet/DotNetSettings" Base1-->Base2["ToolSettings"] click Base2 "/api/Cake.Core.Tooling/ToolSettings" Base2-->Base3["object"] Type["DotNetToolInstallSettings"] class Type type-node

Syntax

public sealed class DotNetToolInstallSettings : DotNetToolSettings

Properties

Name Value Summary
AddSource ICollection<string>
Gets or sets additional package sources to use during installation.
AllowDowngrade bool
Gets or sets a value indicating whether to allow package downgrade when installing a .NET tool package.
AllowRollForward bool
Gets or sets a value indicating whether to allow a .NET tool to roll forward to newer versions of the .NET runtime.
Architecture string
Gets or sets the target architecture.
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
ConfigFile FilePath
Gets or sets the NuGet configuration file to use.
CreateManifestIfNeeded bool
Gets or sets a value indicating whether to create a tool manifest if one is not found.
DiagnosticOutput bool
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
DisableParallel bool
Gets or sets a value indicating whether to prevent restoring multiple projects in parallel.
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
Framework string
Gets or sets the target framework to install the tool for.
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
IgnoreFailedSources bool
Gets or sets a value indicating whether to treat package source failures as warnings.
InstallationScope DotNetToolInstallationScope
Gets or sets the installation scope for the tool.
Interactive bool
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
NoHttpCache bool
Gets or sets a value indicating whether to not cache packages and HTTP requests.
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
Prerelease bool
Gets or sets a value indicating whether to include prerelease packages.
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
Source ICollection<string>
Gets or sets the package sources to use instead of configured NuGet package sources.
ToolInstallationPath DirectoryPath
Gets or sets the directory where the tool will be installed when InstallationScope is ToolPath. When not set, the Cake tools directory is used.
ToolManifest FilePath
Gets or sets the path to the local tool manifest file.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Verbosity DotNetVerbosity?
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
Version string
Gets or sets the tool package version to install.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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