DockerComposeCpSettings Class

Summary

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

Syntax

public sealed class DockerComposeCpSettings : 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
All bool
Copy to all the containers of the service.
Archive bool
Archive mode (copy all uid/gid information)
FollowLink bool
Always follow symbol link in SRC_PATH
Index Nullable<int>
Index of the container if there are multiple instances of a service [default: 1]. (default 1)

Methods

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

Extension Methods

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