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.Docker.
Summary
Base class for tooling that is used for autogeneration of command line arguments.
- Assembly
- Cake
.Docker .dll - Namespace
- Cake
.Docker - Base Types
-
- ToolSettings
- Derived Types
-
- Docker
Manifest Annotate Settings - Docker
Swarm Update Settings - Docker
Image Push Settings - Docker
Container Create Settings - Docker
Compose Cp Settings - Docker
Volume Inspect Settings - Docker
Build X Build Settings - Docker
Compose Settings - Docker
Network Remove Settings - Docker
Volume Create Settings - Docker
Volume Rm Settings - Docker
Container Run Settings - Docker
Build X Use Settings - Docker
Build X Version Settings - Docker
Volume Ls Settings - Docker
Build X Ls Settings - Docker
Network Disconnect Settings - Docker
Image Build Settings - Docker
Build X Bake Settings - Docker
Build X Install Settings - Docker
Image Tag Settings - Docker
Manifest Inspect Settings - Docker
Container Ls Settings - Docker
Container Start Settings - Docker
Container Cp Settings - Docker
Volume Prune Settings - EmptySettings
- Docker
Swarm Join Settings - Docker
Network Connect Settings - Docker
Container Rm Settings - Docker
Manifest Create Settings - Docker
Network Create Settings - Docker
Image Remove Settings - Docker
Custom Command Settings - Docker
Build X Uninstall Settings - Docker
Registry Login Settings - Docker
Build X Rm Settings - Docker
Container Ps Settings - Docker
Container Logs Settings - Docker
Build X Stop Settings - Docker
Build X Image Tools Inspect Settings - Docker
Image Ls Settings - Docker
Build X Prune Settings - Docker
Container Stop Settings - Docker
Manifest Push Settings - Docker
Image Load Settings - Docker
Swarm Init Settings - Docker
Registry Logout Settings - Docker
Image Prune Settings - Docker
Swarm Leave Settings - Docker
Build X Du Settings - Docker
Image Save Settings - Docker
Container Exec Settings - Docker
Build X Create Settings - Docker
Image Pull Settings - Docker
Build X Image Tools Create Settings - Docker
Build X Inspect Settings
- Docker
graph BT
Type-->Base0["ToolSettings"]
Type["AutoToolSettings"]
class Type type-node
Derived0["DockerManifestAnnotateSettings"]-->Type
click Derived0 "/api/Cake.Docker/DockerManifestAnnotateSettings"
Derived1["DockerSwarmUpdateSettings"]-->Type
click Derived1 "/api/Cake.Docker/DockerSwarmUpdateSettings"
Derived2["DockerImagePushSettings"]-->Type
click Derived2 "/api/Cake.Docker/DockerImagePushSettings"
Derived3["DockerContainerCreateSettings"]-->Type
click Derived3 "/api/Cake.Docker/DockerContainerCreateSettings"
Derived4["DockerComposeCpSettings"]-->Type
click Derived4 "/api/Cake.Docker/DockerComposeCpSettings"
Derived5["DockerVolumeInspectSettings"]-->Type
click Derived5 "/api/Cake.Docker/DockerVolumeInspectSettings"
Derived6["DockerBuildXBuildSettings"]-->Type
click Derived6 "/api/Cake.Docker/DockerBuildXBuildSettings"
Derived7["DockerComposeSettings"]-->Type
click Derived7 "/api/Cake.Docker/DockerComposeSettings"
Derived8["DockerNetworkRemoveSettings"]-->Type
click Derived8 "/api/Cake.Docker/DockerNetworkRemoveSettings"
Derived9["DockerVolumeCreateSettings"]-->Type
click Derived9 "/api/Cake.Docker/DockerVolumeCreateSettings"
Derived10["DockerVolumeRmSettings"]-->Type
click Derived10 "/api/Cake.Docker/DockerVolumeRmSettings"
Derived11["DockerContainerRunSettings"]-->Type
click Derived11 "/api/Cake.Docker/DockerContainerRunSettings"
Derived12["DockerBuildXUseSettings"]-->Type
click Derived12 "/api/Cake.Docker/DockerBuildXUseSettings"
Derived13["DockerBuildXVersionSettings"]-->Type
click Derived13 "/api/Cake.Docker/DockerBuildXVersionSettings"
Derived14["DockerVolumeLsSettings"]-->Type
click Derived14 "/api/Cake.Docker/DockerVolumeLsSettings"
Derived15["DockerBuildXLsSettings"]-->Type
click Derived15 "/api/Cake.Docker/DockerBuildXLsSettings"
Derived16["DockerNetworkDisconnectSettings"]-->Type
click Derived16 "/api/Cake.Docker/DockerNetworkDisconnectSettings"
Derived17["DockerImageBuildSettings"]-->Type
click Derived17 "/api/Cake.Docker/DockerImageBuildSettings"
Derived18["DockerBuildXBakeSettings"]-->Type
click Derived18 "/api/Cake.Docker/DockerBuildXBakeSettings"
Derived19["DockerBuildXInstallSettings"]-->Type
click Derived19 "/api/Cake.Docker/DockerBuildXInstallSettings"
Derived20["DockerImageTagSettings"]-->Type
click Derived20 "/api/Cake.Docker/DockerImageTagSettings"
Derived21["DockerManifestInspectSettings"]-->Type
click Derived21 "/api/Cake.Docker/DockerManifestInspectSettings"
Derived22["DockerContainerLsSettings"]-->Type
click Derived22 "/api/Cake.Docker/DockerContainerLsSettings"
Derived23["DockerContainerStartSettings"]-->Type
click Derived23 "/api/Cake.Docker/DockerContainerStartSettings"
Derived24["DockerContainerCpSettings"]-->Type
click Derived24 "/api/Cake.Docker/DockerContainerCpSettings"
Derived25["DockerVolumePruneSettings"]-->Type
click Derived25 "/api/Cake.Docker/DockerVolumePruneSettings"
Derived26["EmptySettings"]-->Type
click Derived26 "/api/Cake.Docker/EmptySettings"
Derived27["DockerSwarmJoinSettings"]-->Type
click Derived27 "/api/Cake.Docker/DockerSwarmJoinSettings"
Derived28["DockerNetworkConnectSettings"]-->Type
click Derived28 "/api/Cake.Docker/DockerNetworkConnectSettings"
Derived29["DockerContainerRmSettings"]-->Type
click Derived29 "/api/Cake.Docker/DockerContainerRmSettings"
Derived30["DockerManifestCreateSettings"]-->Type
click Derived30 "/api/Cake.Docker/DockerManifestCreateSettings"
Derived31["DockerNetworkCreateSettings"]-->Type
click Derived31 "/api/Cake.Docker/DockerNetworkCreateSettings"
Derived32["DockerImageRemoveSettings"]-->Type
click Derived32 "/api/Cake.Docker/DockerImageRemoveSettings"
Derived33["DockerCustomCommandSettings"]-->Type
click Derived33 "/api/Cake.Docker/DockerCustomCommandSettings"
Derived34["DockerBuildXUninstallSettings"]-->Type
click Derived34 "/api/Cake.Docker/DockerBuildXUninstallSettings"
Derived35["DockerRegistryLoginSettings"]-->Type
click Derived35 "/api/Cake.Docker/DockerRegistryLoginSettings"
Derived36["DockerBuildXRmSettings"]-->Type
click Derived36 "/api/Cake.Docker/DockerBuildXRmSettings"
Derived37["DockerContainerPsSettings"]-->Type
click Derived37 "/api/Cake.Docker/DockerContainerPsSettings"
Derived38["DockerContainerLogsSettings"]-->Type
click Derived38 "/api/Cake.Docker/DockerContainerLogsSettings"
Derived39["DockerBuildXStopSettings"]-->Type
click Derived39 "/api/Cake.Docker/DockerBuildXStopSettings"
Derived40["DockerBuildXImageToolsInspectSettings"]-->Type
click Derived40 "/api/Cake.Docker/DockerBuildXImageToolsInspectSettings"
Derived41["DockerImageLsSettings"]-->Type
click Derived41 "/api/Cake.Docker/DockerImageLsSettings"
Derived42["DockerBuildXPruneSettings"]-->Type
click Derived42 "/api/Cake.Docker/DockerBuildXPruneSettings"
Derived43["DockerContainerStopSettings"]-->Type
click Derived43 "/api/Cake.Docker/DockerContainerStopSettings"
Derived44["DockerManifestPushSettings"]-->Type
click Derived44 "/api/Cake.Docker/DockerManifestPushSettings"
Derived45["DockerImageLoadSettings"]-->Type
click Derived45 "/api/Cake.Docker/DockerImageLoadSettings"
Derived46["DockerSwarmInitSettings"]-->Type
click Derived46 "/api/Cake.Docker/DockerSwarmInitSettings"
Derived47["DockerRegistryLogoutSettings"]-->Type
click Derived47 "/api/Cake.Docker/DockerRegistryLogoutSettings"
Derived48["DockerImagePruneSettings"]-->Type
click Derived48 "/api/Cake.Docker/DockerImagePruneSettings"
Derived49["DockerSwarmLeaveSettings"]-->Type
click Derived49 "/api/Cake.Docker/DockerSwarmLeaveSettings"
Derived50["DockerBuildXDuSettings"]-->Type
click Derived50 "/api/Cake.Docker/DockerBuildXDuSettings"
Derived51["DockerImageSaveSettings"]-->Type
click Derived51 "/api/Cake.Docker/DockerImageSaveSettings"
Derived52["DockerContainerExecSettings"]-->Type
click Derived52 "/api/Cake.Docker/DockerContainerExecSettings"
Derived53["DockerBuildXCreateSettings"]-->Type
click Derived53 "/api/Cake.Docker/DockerBuildXCreateSettings"
Derived54["DockerImagePullSettings"]-->Type
click Derived54 "/api/Cake.Docker/DockerImagePullSettings"
Derived55["DockerBuildXImageToolsCreateSettings"]-->Type
click Derived55 "/api/Cake.Docker/DockerBuildXImageToolsCreateSettings"
Derived56["DockerBuildXInspectSettings"]-->Type
click Derived56 "/api/Cake.Docker/DockerBuildXInspectSettings"
Syntax
public abstract class AutoToolSettings : ToolSettingsConstructors
| Name | Summary |
|---|---|
| AutoToolSettings |
Initializer. Handles secret properties collection. |
Fields
| Name | Constant Value | Summary |
|---|---|---|
| SecretProperties |
Values of these properties shouldn't be displayed in the output.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Collect |
string[] |
Collects secret properties.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator 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
|
| 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
|