DockerComposeRunSettings Class

Summary

Settings for docker build.
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["DockerComposeSettings"] click Base0 "/api/Cake.Docker/DockerComposeSettings" Base0-->Base1["AutoToolSettings"] click Base1 "/api/Cake.Docker/AutoToolSettings" Base1-->Base2["ToolSettings"] Type["DockerComposeRunSettings"] class Type type-node

Syntax

public sealed class DockerComposeRunSettings : DockerComposeSettings

Constructors

Name Summary
DockerComposeRunSettings()

Fields

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

Properties

Name Value Summary
DetachedMode bool
Detached mode: Run container in the background, print new container name.
Entrypoint string
Override the entrypoint of the image.
Environment string[]
Set an environment variable(can be used multiple times)
Files string[]
Configuration files.
Inherited from DockerComposeSettings
Host string
Daemon socket to connect to
Inherited from DockerComposeSettings
Name bool
Assign a name to the container
NoDeps bool
Don't start linked services.
ProjectDirectory string
Specify an alternate working directory (default: the path of the Compose file)
Inherited from DockerComposeSettings
ProjectName string
Specify an alternate project name (default: directory name)
Inherited from DockerComposeSettings
Publish string[]
Publish a container's port(s) to the host
Rm bool
Remove container after run. Ignored in detached mode.
ServicePorts bool
Run command with the service's ports enabled and mapped to the host.
SkipHostnameCheck bool
Don't check the daemon's hostname against the name specified in the client certificate (for example if your docker host is an IP address)
Inherited from DockerComposeSettings
Tls bool
Use TLS; implied by --tlsverify
Inherited from DockerComposeSettings
Tlscacert string
Trust certs signed only by this CA
Inherited from DockerComposeSettings
Tlscert string
Path to TLS certificate file
Inherited from DockerComposeSettings
Tlskey string
Path to TLS key file
Inherited from DockerComposeSettings
Tlsverify bool
Use TLS and verify the remote
Inherited from DockerComposeSettings
User string
Run as specified username or uid
Verbose bool
Show more output
Inherited from DockerComposeSettings
Version bool
Print version and exit
Inherited from DockerComposeSettings
Volume string[]
Bind mount a volume (default [])

Methods

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

Extension Methods

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