DockerSwarmUpdateSettings Class

Summary

Settings for docker update [OPTIONS]. Update the swarm
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerSwarmUpdateSettings"] class Type type-node

Syntax

public sealed class DockerSwarmUpdateSettings : 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
CertExpiry string
--cert-expiry default: 90*24*time.Hour Validity period for node certificates (ns|us|ms|s|m|h)
DispatcherHeartbeat string
--dispatcher-heartbeat default: 5*time.Second Dispatcher heartbeat period (ns|us|ms|s|m|h)
ExternalCa string
--external-ca Specifications of one or more certificate signing endpoints
MaxSnapshots string
--max-snapshots
SnapshotInterval string
--snapshot-interval
TaskHistoryLimit Nullable<long>
--task-history-limit default: 5 Task history retention limit

Methods

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

Extension Methods

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