This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Curl.

Summary

Contains the settings used by curl.

Assembly

Cake.Curl.dll

Namespace

Cake.Curl

Base Types

ToolSettings

Derived Types

CurlDownloadSettings

graph BT Type-->Base0["ToolSettings"] Type["CurlSettings"] class Type type-node Derived0["CurlDownloadSettings"]-->Type click Derived0 "/api/Cake.Curl/CurlDownloadSettings"

Syntax

public class CurlSettings : ToolSettings

Constructors

Name	Summary
CurlSettings()

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.
Fail	bool	Gets or sets a value indicating whether HTTP errors should result in a non-zero exit code.
FollowRedirects	bool	Gets or sets a value indicating whether to follow HTTP redirects.
Headers	IDictionary<string, string>	Gets or sets the header to use when communicating to the remote host.
MaxTime	Nullable<TimeSpan>	Gets or sets the maximum amount of time the operation is allowed to take.
Password	string	Gets or sets the password to use when authenticating to the remote host.
ProgressBar	bool	Gets or sets a value indicating whether to display a simple progress bar instead of the standard progress meter.
RequestCommand	string	Gets or sets the command to use in the request.
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.
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.
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.
RetryOnConnectionRefused	bool	Gets or sets a value indicating whether curl should consider `ECONNREFUSED` as a failed operation before retrying. The default value is .
Username	string	Gets or sets the username to use when authenticating to the remote host.
Verbose	bool	Gets or sets a value indicating whether to enable verbose output.

Extension Methods

Name	Value	Summary
Dump<CurlSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CurlSettings>(CurlSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CurlSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<CurlSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<CurlSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<CurlSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

CurlSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods