DockerContainerRmSettings Class

Summary

Settings for docker rm [OPTIONS] CONTAINER [CONTAINER...]. Remove one or more containers
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerContainerRmSettings"] class Type type-node

Syntax

public sealed class DockerContainerRmSettings : 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
Force Nullable<bool>
--force, -f default: false Force the removal of a running container (uses SIGKILL)
Link Nullable<bool>
--link, -l default: false Remove the specified link
Volumes Nullable<bool>
--volumes, -v default: false Remove the volumes associated with the container

Methods

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

Extension Methods

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