DockerContainerStopSettings Class

Summary

Settings for docker stop [OPTIONS] CONTAINER [CONTAINER...]. Stop one or more running 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["DockerContainerStopSettings"] class Type type-node

Syntax

public sealed class DockerContainerStopSettings : 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
Time Nullable<int>
--time, -t default: 10 Seconds to wait for stop before killing it

Methods

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

Extension Methods

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