DockerNetworkConnectSettings Class

Summary

Settings for docker connect [OPTIONS] NETWORK CONTAINER. Connect a container to a network
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerNetworkConnectSettings"] class Type type-node

Syntax

public sealed class DockerNetworkConnectSettings : 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
Alias string[]
--alias default: Add network-scoped alias for the container
Ip string
--ip IPv4 address (e.g., 172.30.100.104)
Ip6 string
--ip6 IPv6 address (e.g., 2001:db8::33)
Link string[]
--link Add link to another container
LinkLocalIp string[]
--link-local-ip default: Add a link-local address for the container

Methods

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

Extension Methods

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