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 exec.

Assembly

Cake.Docker.dll

Namespace

Cake.Docker

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerComposeExecSettings"] class Type type-node

Syntax

public sealed class DockerComposeExecSettings : AutoToolSettings

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

Name	Summary
DockerComposeExecSettings()

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>	Detached mode: Run command in the background.
Env	string[]	Set environment variables
Index	Nullable<int>	index of the container if service has multiple replicas
NoTTY	Nullable<bool>	compose exec Disable pseudo-TTY allocation. By default docker compose exec allocates a TTY.
Privileged	Nullable<bool>	Give extended privileges to the process.
User	string	Run the command as this user.
Workdir	string	Path to workdir directory for this command.

Methods

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

Extension Methods

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

DockerComposeExecSettings Class