DockerComposeSettings Class

Summary

Generic docker-compose settings.
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerComposeSettings"] class Type type-node Derived0["DockerComposeDownSettings"]-->Type click Derived0 "/api/Cake.Docker/DockerComposeDownSettings" Derived1["DockerComposeRunSettings"]-->Type click Derived1 "/api/Cake.Docker/DockerComposeRunSettings" Derived2["DockerComposeStopSettings"]-->Type click Derived2 "/api/Cake.Docker/DockerComposeStopSettings" Derived3["DockerComposeExecSettings"]-->Type click Derived3 "/api/Cake.Docker/DockerComposeExecSettings" Derived4["DockerComposePortSettings"]-->Type click Derived4 "/api/Cake.Docker/DockerComposePortSettings" Derived5["DockerComposeCreateSettings"]-->Type click Derived5 "/api/Cake.Docker/DockerComposeCreateSettings" Derived6["DockerComposeRmSettings"]-->Type click Derived6 "/api/Cake.Docker/DockerComposeRmSettings" Derived7["DockerComposeRestartSettings"]-->Type click Derived7 "/api/Cake.Docker/DockerComposeRestartSettings" Derived8["DockerComposeUpSettings"]-->Type click Derived8 "/api/Cake.Docker/DockerComposeUpSettings" Derived9["DockerComposePullSettings"]-->Type click Derived9 "/api/Cake.Docker/DockerComposePullSettings" Derived10["DockerComposeLogsSettings"]-->Type click Derived10 "/api/Cake.Docker/DockerComposeLogsSettings" Derived11["DockerComposePsSettings"]-->Type click Derived11 "/api/Cake.Docker/DockerComposePsSettings" Derived12["DockerComposeBuildSettings"]-->Type click Derived12 "/api/Cake.Docker/DockerComposeBuildSettings" Derived13["DockerComposeKillSettings"]-->Type click Derived13 "/api/Cake.Docker/DockerComposeKillSettings"

Syntax

public class DockerComposeSettings : 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
Files string[]
Configuration files.
Host string
Daemon socket to connect to
ProjectDirectory string
Specify an alternate working directory (default: the path of the Compose file)
ProjectName string
Specify an alternate project name (default: directory name)
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)
Tls bool
Use TLS; implied by --tlsverify
Tlscacert string
Trust certs signed only by this CA
Tlscert string
Path to TLS certificate file
Tlskey string
Path to TLS key file
Tlsverify bool
Use TLS and verify the remote
Verbose bool
Show more output
Version bool
Print version and exit

Methods

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

Extension Methods

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