ChocolateyUpgradeSettings Class

Summary

Contains settings used by ChocolateyUpgrader.
Namespace
Cake.Common.Tools.Chocolatey.Upgrade
Base Types
graph BT Type-->Base0["ChocolateySharedSettings"] click Base0 "/api/Cake.Common.Tools.Chocolatey/ChocolateySharedSettings" Base0-->Base1["ChocolateySettings"] click Base1 "/api/Cake.Common.Tools.Chocolatey/ChocolateySettings" Base1-->Base2["ToolSettings"] click Base2 "/api/Cake.Core.Tooling/ToolSettings" Base2-->Base3["object"] Type["ChocolateyUpgradeSettings"] class Type type-node

Syntax

public sealed class ChocolateyUpgradeSettings : ChocolateySharedSettings

Properties

Name Value Summary
AcceptLicense bool
Gets or sets a value indicating whether to accept license for package.
Inherited from ChocolateySettings
AllowDowngrade bool
Gets or sets a value indicating whether to allow downgrade of package.
AllowEmptyChecksums bool
Gets or sets a value indicating whether to allow empty checksums for bare HTTP URLs during package installation.
AllowEmptyChecksumsSecure bool
Gets or sets a value indicating whether to allow empty checksums for HTTPS URLs during package installation.
AllowUnofficial bool
Gets or sets a value indicating whether to run in allow unofficial mode.
Inherited from ChocolateySettings
ApplyInstallArgumentsToDependencies bool
Gets or sets a value indicating whether install arguments be applied to dependent packages.
ApplyPackageParametersToDependencies bool
Gets or sets a value indicating whether package parameters be applied to dependent packages.
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
CacheLocation string
Gets or sets the location of the download cache.
Inherited from ChocolateySettings
Certificate FilePath
Gets or sets the path to a PFX certificate for use with x509 authenticated feeds.
CertificatePassword string
Gets or sets the password for the Certificate.
Checksum string
Gets or sets the checksum for 32 bit installation.
Checksum64 string
Gets or sets the checksum for 64 bit installation.
ChecksumType string
Gets or sets the checksum type to use for 32 bit installation.
ChecksumType64 string
Gets or sets the checksum type to use for 64 bit installation.
Debug bool
Gets or sets a value indicating whether to run in debug mode.
Inherited from ChocolateySettings
DisableRepositoryOptimizations bool
Gets or sets a value indicating whether to use optimizations for reducing bandwidth when communicating with repositories.
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
Except string
Gets or sets a comma separated list of package names that should not be upgraded when running upgrade all.
ExcludeChocolateyPackagesDuringUpgradeAll bool
Gets or sets a value indicating whether to exclude all Chocolatey owned packages during upgrade all operation.
ExcludePrerelease bool
Gets or sets a value indicating whether prerelease packages should be ignored for upgrades.
ExecutionTimeout int
Gets or sets the execution timeout value.
Inherited from ChocolateySettings
ExitWhenRebootDetected bool
Gets or sets a value indicating whether to exit when a reboot is detected.
FailOnErrorOutput bool
Gets or sets a value indicating whether to faile when error output is detected.
Inherited from ChocolateySettings
FailOnNotInstalled bool
Gets or sets a value indicating whether to fail on not installed packages.
FailOnUnfound bool
Gets or sets a value indicating whether to fail on unfound packages.
Force bool
Gets or sets a value indicating whether to run in forced mode.
Inherited from ChocolateySettings
Forcex86 bool
Gets or sets a value indicating whether to force installation of the x86 version of package.
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
IgnoreChecksums bool
Gets or sets a value indicating whether to ignore checksums.
IgnoreDependencies bool
Gets or sets a value indicating whether to ignore dependencies.
IgnoreDetectedReboot bool
Gets or sets a value indicating whether to ignore detected reboots.
IgnorePackageExitCodes bool
Gets or sets a value indicating whether to Exit with a 0 for success and 1 for non-success no matter what package scripts provide for exit codes.
IgnoreRememeredArguments bool
Gets or sets a value indicating whether to ignore the remembered arguments for package.
IgnoreUnfound bool
Gets or sets a value indicating whether to ignore unfound packages if downloading more than one at a time.
IncludeChocolateyPackagesDuringUpgradeAll bool
Gets or sets a value indicating whether to include all Chocolatey owned packages during upgrade all operation.
InstallArguments string
Gets or sets the install arguments to pass to native installer.
InstallArgumentsSensitive string
Gets or sets the install arguments sensitive to pass to native installer.
InstallDirectory DirectoryPath
Gets or sets the default application installation directory.
InstallIfNotInstalled bool
Gets or sets a value indicating whether to install a package that is not installed during the upgrade operation.
LimitOutput bool
Gets or sets a value indicating whether to run in limited output mode.
Inherited from ChocolateySettings
LogFile FilePath
Gets or sets the path to the file where all log entries will be sent.
Inherited from ChocolateySettings
MaximumDownloadBitsPerSecond int
Gets or sets the maximum download bits per second when downloading a package.
NoColor bool
Gets or sets a value indicating whether to run in no color mode.
Inherited from ChocolateySettings
Noop bool
Gets or sets a value indicating whether to run in noop mode.
Inherited from ChocolateySettings
NoProgress bool
Gets or sets a value indicating whether to run while not showing download progress.
Inherited from ChocolateySettings
NoReducePackageSize bool
Gets or sets a value indicating whether there should be no reduction in package size on installation.
NotSilent bool
Gets or sets a value indicating whether to process package silently.
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
OverrideArguments bool
Gets or sets a value indicating whether install arguments be used exclusively without appending to current package passed arguments.
PackageParameters string
Gets or sets parameters to pass to the package.
PackageParametersSensitive string
Gets or sets sensitive parameters to pass to the package.
Password string
Gets or sets the password for authenticated feeds.
Pin bool
Gets or sets a value indicating whether to pin the package once installed.
PinReason string
Gets or sets a reason for pinning a package during installation.
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 allow upgrading to prerelease versions. This flag is not required when updating prerelease packages that are already installed.
Proxy string
Gets or sets the explicit proxy location.
Inherited from ChocolateySettings
ProxyByPassList string
Gets or sets the comma separated list of regex location to bypass on proxy.
Inherited from ChocolateySettings
ProxyBypassOnLocal bool
Gets or sets a value indicating whether to bypass proxy for local connections.
Inherited from ChocolateySettings
ProxyPassword string
Gets or sets the explicit proxy password.
Inherited from ChocolateySettings
ProxyUser string
Gets or sets the explicit proxy user.
Inherited from ChocolateySettings
ReduceNupkgOnly bool
Gets or sets a value indicating whether only the nupkg file size should be reduced.
ReducePackageSize bool
Gets or sets a value indicating whether package size should be reduced on installation.
RequireChecksums bool
Gets or sets a value indicating whether checksums are required during package installation.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
SideBySide bool
Gets or sets a value indicating whether multiple versions of a package be installed.
SkipCompatibilityChecks bool
Gets or sets a value indicating whether to skip all compatibility checks.
Inherited from ChocolateySettings
SkipDownloadCache bool
Gets or sets a value indicating whether to skip the package download cache.
SkipHooks bool
Gets or sets a value indicating whether to skip the running of package hook scripts.
SkipIfNotInstalled bool
Gets or sets a value indicating whether a package will be skipped if it is not installed during upgrade operation.
SkipPowerShell bool
Gets or sets a value indicating whether to run chocolateyInstall.ps1.
SkipVirusCheck bool
Gets or sets a value indicating whether skip the virus checking for a package.
Source string
Gets or sets the source to find the package(s).
StopOnFirstFailure bool
Gets or sets a value indicating whether to stop of the first failure of a package.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Trace bool
Gets or sets a value indicating whether to run in trace mode.
Inherited from ChocolateySettings
UseDownloadCache bool
Gets or sets a value indicating whether to use the package download cache.
UsePackageExitCodes bool
Gets or sets a value indicating whether to use package exit codes.
User string
Gets or sets the user for authenticated feeds.
UseRememberedArguments bool
Gets or sets a value indicating whether to use the remembered arguments for a package.
UseSystemPowerShell bool
Gets or sets a value indicating whether to run using system installed version of PowerShell.
Inherited from ChocolateySettings
Verbose bool
Gets or sets a value indicating whether to run in verbose mode.
Inherited from ChocolateySettings
Version string
Gets or sets the specific version of the package.
VirusCheck bool
Gets or sets a value indicating whether to force virus checking for a package.
VirusPositivesMinimum int
Gets or sets the minimum allowed number of virus positives.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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