DotNetCoreRestoreSettings Class

Summary

Contains settings used by DotNetCoreRestoreSettings.
graph BT Type-->Base0["DotNetRestoreSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.Restore/DotNetRestoreSettings" 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["DotNetCoreRestoreSettings"] class Type type-node

Syntax

public sealed class DotNetCoreRestoreSettings : DotNetRestoreSettings

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
ConfigFile FilePath
Gets or sets the NuGet configuration file to use.
Inherited from DotNetRestoreSettings
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 disable restoring multiple projects in parallel.
Inherited from DotNetRestoreSettings
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
Force bool
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting the project.assets.json file. Note: This flag was introduced with the .NET Core 2.x release.
Inherited from DotNetRestoreSettings
ForceEvaluate bool
Gets or sets a value indicating whether to force restore to reevaluate all dependencies even if a lock file already exists.
Inherited from DotNetRestoreSettings
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 only warning failed sources if there are packages meeting version requirement.
Inherited from DotNetRestoreSettings
Interactive bool
Gets or sets a value indicating whether to stop and wait for user input or action (for example to complete authentication).
Inherited from DotNetRestoreSettings
LockedMode bool
Gets or sets a value indicating whether to not allow updating project lock file.
Inherited from DotNetRestoreSettings
LockFilePath FilePath
Gets or sets a value indicating output location where project lock file is written.
Inherited from DotNetRestoreSettings
MSBuildSettings DotNetMSBuildSettings
Gets or sets additional arguments to be passed to MSBuild.
Inherited from DotNetRestoreSettings
NoCache bool
Gets or sets a value indicating whether to do not cache packages and http requests.
Inherited from DotNetRestoreSettings
NoDependencies bool
Gets or sets a value indicating whether to ignore project to project references and restore only the root project.
Inherited from DotNetRestoreSettings
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
PackagesDirectory DirectoryPath
Gets or sets the directory to install packages in.
Inherited from DotNetRestoreSettings
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
RollForward DotNetRollForward?
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
Runtime string
Gets or sets the target runtime to restore packages for.
Inherited from DotNetRestoreSettings
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
Sources ICollection<string>
Gets or sets the specified NuGet package sources to use during the restore.
Inherited from DotNetRestoreSettings
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
UseLockFile bool
Gets or sets a value indicating whether to enable project lock file to be generated and used with restore.
Inherited from DotNetRestoreSettings
Verbosity DotNetVerbosity?
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

Name Value Summary
Dump<DotNetCoreRestoreSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DotNetCoreRestoreSettings>(DotNetCoreRestoreSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DotNetCoreRestoreSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DotNetCoreRestoreSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DotNetCoreRestoreSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DotNetCoreRestoreSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin