DockerVolumeRmSettings Class

Summary

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

Syntax

public sealed class DockerVolumeRmSettings : 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 bool
Force the removal of one or more volumes

Methods

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

Extension Methods

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