CurlDownloadSettings Class

Summary

Contains the settings used by curl when downloading one or more files from remote URLs.
Assembly
Cake.Curl.dll
Namespace
Cake.Curl
Base Types
graph BT Type-->Base0["CurlSettings"] click Base0 "/api/Cake.Curl/CurlSettings" Base0-->Base1["ToolSettings"] Type["CurlDownloadSettings"] class Type type-node

Syntax

public sealed class CurlDownloadSettings : CurlSettings

Constructors

Name Summary
CurlDownloadSettings()

Properties

Name Value Summary
ConnectionTimeout Nullable<TimeSpan>
Gets or sets the maximum amount of time the connection to the remote machine is allowed to take.
Inherited from CurlSettings
CreateDirectories bool
Gets or sets a value indicating whether curl should create the directory hierarchy specified in the OutputPaths locally.
Fail bool
Gets or sets a value indicating whether HTTP errors should result in a non-zero exit code.
Inherited from CurlSettings
FollowRedirects bool
Gets or sets a value indicating whether to follow HTTP redirects.
Inherited from CurlSettings
Headers IDictionary<string, string>
Gets or sets the header to use when communicating to the remote host.
Inherited from CurlSettings
MaxTime Nullable<TimeSpan>
Gets or sets the maximum amount of time the operation is allowed to take.
Inherited from CurlSettings
OutputPaths IEnumerable<FilePath>
Gets or sets the sequence of local FilePath where to save the downloaded files.
Password string
Gets or sets the password to use when authenticating to the remote host.
Inherited from CurlSettings
ProgressBar bool
Gets or sets a value indicating whether to display a simple progress bar instead of the standard progress meter.
Inherited from CurlSettings
RequestCommand string
Gets or sets the command to use in the request.
Inherited from CurlSettings
RetryCount uint
Gets or sets the number of times curl should retry a failed operation before giving up. Setting this property to zero means no retries. This is the default value.
Inherited from CurlSettings
RetryDelaySeconds uint
Gets or sets the amount of time curl should wait before retrying a failed operation. Setting this property to zero means using curl's own exponential wait algorithm. This is the default value.
Inherited from CurlSettings
RetryMaxTimeSeconds uint
Gets or sets the maximum amount of time during which curl should retry a failed operation. Setting this property to zero means retrying without a time limit. This is the default value.
Inherited from CurlSettings
RetryOnConnectionRefused bool
Gets or sets a value indicating whether curl should consider 
ECONNREFUSED
as a failed operation before retrying. The default value is .
Inherited from CurlSettings
Username string
Gets or sets the username to use when authenticating to the remote host.
Inherited from CurlSettings
Verbose bool
Gets or sets a value indicating whether to enable verbose output.
Inherited from CurlSettings

Extension Methods

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