DockerContainerExecSettings Class

Summary

Settings for docker exec [OPTIONS] CONTAINER COMMAND [ARG...]. Run a command in a running container
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerContainerExecSettings"] class Type type-node

Syntax

public sealed class DockerContainerExecSettings : 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
Detach Nullable<bool>
--detach, -d default: false Detached mode: run command in the background
DetachKeys string
--detach-keys Override the key sequence for detaching a container
Env string[]
--env, -e Set environment variables
Interactive Nullable<bool>
--interactive, -i default: false Keep STDIN open even if not attached
Privileged Nullable<bool>
--privileged default: false Give extended privileges to the command
Tty Nullable<bool>
--tty, -t default: false Allocate a pseudo-TTY
User string
--user, -u Username or UID (format: <name|uid>[:<group|gid>])
Workdir string
--workdir, -w Working directory inside the container

Methods

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

Extension Methods

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