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

Settings for docker-compose ps.

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["DockerComposePsSettings"] class Type type-node

Syntax

public sealed class DockerComposePsSettings : DockerComposeSettings

Constructors

Name	Summary
DockerComposePsSettings()

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. Inherited from DockerComposeSettings
Filters	string[]	--filter Filter services by a property.
Host	string	Daemon socket to connect to Inherited from DockerComposeSettings
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
Quiet	Nullable<bool>	--quiet, -q Only display IDs
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
Verbose	bool	Show more output Inherited from DockerComposeSettings
Version	bool	Print version and exit Inherited from DockerComposeSettings

Methods

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

Extension Methods

Name	Value	Summary
Dump<DockerComposePsSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DockerComposePsSettings>(DockerComposePsSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DockerComposePsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DockerComposePsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<DockerComposePsSettings>(string, string)	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<DockerComposePsSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin