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.Kudu.Client.
Summary
Represents a client that talks to Kudu rest API.
- Assembly
- Cake
.Kudu .Client .dll - Namespace
- Cake
.Kudu .Client
graph BT
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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
ExecuteCommand |
IKuduCommandResult |
Executes an arbitrary command line and return its output.
Requires the Cake.Kudu.Client addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
SettingsDelete |
void |
Delete setting from appservice.
Requires the Cake.Kudu.Client addin
|
SettingsGet |
IReadOnlyDictionary |
Get settings from appservice.
Requires the Cake.Kudu.Client addin
|
SettingsSet |
void |
Set settings to appservice.
Requires the Cake.Kudu.Client addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
VFSCreateDirectory |
void |
Creates directory on remote path.
Requires the Cake.Kudu.Client addin
|
VFSDeleteDirectory |
void |
Deletes remote directory.
Requires the Cake.Kudu.Client addin
|
VFSDeleteFile |
void |
Deletes remote file.
Requires the Cake.Kudu.Client addin
|
VFSDownloadFile |
void |
Downloads remote file locally.
Requires the Cake.Kudu.Client addin
|
VFSDownloadStream |
Stream |
Downloads remote file to stream.
Requires the Cake.Kudu.Client addin
|
VFSDownloadString |
string |
Downloads remote file as string.
Requires the Cake.Kudu.Client addin
|
VFSList |
IKuduVFS |
Lists remote resources for a given path.
Requires the Cake.Kudu.Client addin
|
VFSUploadFile |
void |
Uploads file to remote path.
Requires the Cake.Kudu.Client addin
|
VFSUploadStream |
void |
Uploads stream to remote path.
Requires the Cake.Kudu.Client addin
|
VFSUploadString |
void |
Uploads stream to remote path.
Requires the Cake.Kudu.Client addin
|
ZipDeployDirectory |
void |
Deploy local directory to KuduWebsite.
Requires the Cake.Kudu.Client addin
|
ZipDeployFile |
void |
Deploys zip file to Kudu wesite.
Requires the Cake.Kudu.Client addin
|
ZipDeployStream |
void |
Deploys zip stream Kudu website.
Requires the Cake.Kudu.Client addin
|
ZipDownloadFile |
void |
Downloads remote directory to local zip file.
Requires the Cake.Kudu.Client addin
|
ZipDownloadStream |
Stream |
Downloads remote directory as zip to stream.
Requires the Cake.Kudu.Client addin
|
ZipRunFromDirectory |
FilePath |
Deploy local directory to KuduWebsite as read only Zip file system.
Requires the Cake.Kudu.Client addin
|
ZipRunFromDirectory |
FilePath |
Deploy local directory to KuduWebsite as read only Zip file system.
Requires the Cake.Kudu.Client addin
|
ZipUploadDirectory |
void |
Uploads zip stream and extracts to remote directory path.
Requires the Cake.Kudu.Client addin
|
ZipUploadFile |
void |
Uploads zip file to expand into remote directory path.
Requires the Cake.Kudu.Client addin
|
ZipUploadStream |
void |
Uploads zip stream and extracts to remote directory path.
Requires the Cake.Kudu.Client addin
|