KuduClientSettings Class

Summary

Represents client settings used by Kudu client.
Assembly
Cake.Kudu.Client.dll
Namespace
Cake.Kudu.Client
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["KuduClientSettings"] class Type type-node

Syntax

public class KuduClientSettings

Constructors

Name Summary
KuduClientSettings(string, string, string) Initializes a new instance of the KuduClientSettings class.

Properties

Name Value Summary
BaseUri string
Gets the base uri for site Kudu environment.
Environment ICakeEnvironment
Gets or sets the environment used by kudu client.
FileSystem IFileSystem
Gets or sets the local file system used by client.
HttpClientCustomization Func<KuduClientSettings, HttpClient, HttpClient>
Gets or sets the delegate for customizing the HttpClient used for API options.
Log ICakeLog
Gets or sets the log used by kudu client.
Password string
Gets the password used to authenticate agains Kudu api.
Timeout TimeSpan
Gets or sets the timeout for API operations.
UserName string
Gets the user name used to authenticate agains Kudu api.

Extension Methods

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