IKuduClient Interface

Summary

Represents a client that talks to Kudu rest API.
graph TD Type["IKuduClient"] class Type type-node

Syntax

public interface IKuduClient

Properties

Name Value Summary
Environment ICakeEnvironment
Gets the Cake environment.
FileSystem IFileSystem
Gets the Cake context.
HttpClient HttpClient
Gets the underlying HttpClient used for remote API calls.
Log ICakeLog
Gets the Cake log.
Settings KuduClientSettings
Gets the Kudu client settings.

Extension Methods

Name Value Summary
Dump<IKuduClient>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ExecuteCommand(string, string, ProcessArgumentBuilder) IKuduCommandResult
Executes an arbitrary command line and return its output.
Requires the Cake.Kudu.Client addin
IsIn<IKuduClient>(IKuduClient[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IKuduClient>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<IKuduClient>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SettingsDelete(string) void
Delete setting from appservice.
Requires the Cake.Kudu.Client addin
SettingsGet() IReadOnlyDictionary<string, string>
Get settings from appservice.
Requires the Cake.Kudu.Client addin
SettingsSet(IReadOnlyDictionary<string, string>) void
Set settings to appservice.
Requires the Cake.Kudu.Client addin
ThrowIfNull<IKuduClient>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IKuduClient>(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
VFSCreateDirectory(DirectoryPath) void
Creates directory on remote path.
Requires the Cake.Kudu.Client addin
VFSDeleteDirectory(DirectoryPath) void
Deletes remote directory.
Requires the Cake.Kudu.Client addin
VFSDeleteFile(FilePath) void
Deletes remote file.
Requires the Cake.Kudu.Client addin
VFSDownloadFile(FilePath, FilePath) void
Downloads remote file locally.
Requires the Cake.Kudu.Client addin
VFSDownloadStream(FilePath) Stream
Downloads remote file to stream
Requires the Cake.Kudu.Client addin
VFSDownloadString(FilePath, Encoding) string
Downloads remote file as string.
Requires the Cake.Kudu.Client addin
VFSList(DirectoryPath) IKuduVFS
Lists remote resources for a given path.
Requires the Cake.Kudu.Client addin
VFSUploadFile(FilePath, FilePath) void
Uploads file to remote path.
Requires the Cake.Kudu.Client addin
VFSUploadStream(Stream, FilePath) void
Uploads stream to remote path.
Requires the Cake.Kudu.Client addin
VFSUploadString(string, FilePath, Encoding) void
Uploads stream to remote path.
Requires the Cake.Kudu.Client addin
ZipDeployDirectory(DirectoryPath) void
Deploy local directory to KuduWebsite
Requires the Cake.Kudu.Client addin
ZipDeployFile(FilePath) void
Deploys zip file to Kudu wesite.
Requires the Cake.Kudu.Client addin
ZipDeployStream(Stream) void
Deploys zip stream Kudu website.
Requires the Cake.Kudu.Client addin
ZipDownloadFile(DirectoryPath, FilePath) void
Downloads remote directory to local zip file.
Requires the Cake.Kudu.Client addin
ZipDownloadStream(DirectoryPath) Stream
Downloads remote direactory as zip to stream.
Requires the Cake.Kudu.Client addin
ZipRunFromDirectory(DirectoryPath) FilePath
Deploy local directory to KuduWebsite as read only Zip file system
Requires the Cake.Kudu.Client addin
ZipRunFromDirectory(DirectoryPath, bool, string, string) FilePath
Deploy local directory to KuduWebsite as read only Zip file system
Requires the Cake.Kudu.Client addin
ZipUploadDirectory(DirectoryPath, DirectoryPath) void
Uploads zip stream and extracts to remote directory path.
Requires the Cake.Kudu.Client addin
ZipUploadFile(FilePath, DirectoryPath) void
Uploads zip file to expand into remote directory path.
Requires the Cake.Kudu.Client addin
ZipUploadStream(Stream, DirectoryPath) void
Uploads zip stream and extracts to remote directory path.
Requires the Cake.Kudu.Client addin