DockerContainerStartSettings Class

Summary

Settings for docker start [OPTIONS] CONTAINER [CONTAINER...]. Start one or more stopped containers
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerContainerStartSettings"] class Type type-node

Syntax

public sealed class DockerContainerStartSettings : AutoToolSettings

Constructors

Fields

Name Constant Value Summary
SecretProperties
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings

Properties

Name Value Summary
Attach Nullable<bool>
--attach, -a default: false Attach STDOUT/STDERR and forward signals
Checkpoint string
--checkpoint Restore from this checkpoint
CheckpointDir string
--checkpoint-dir Use a custom checkpoint storage directory
DetachKeys string
--detach-keys Override the key sequence for detaching a container
Interactive Nullable<bool>
--interactive, -i default: false Attach container's STDIN

Methods

Name Value Summary
CollectSecretProperties() string[]
Collects secret properties.
Inherited from AutoToolSettings

Extension Methods

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