Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model/Network

Network

@Serializable

data class Network(val name: String? = null, val id: String? = null, val created: String? = null, val scope: String? = null, val driver: String? = null, val enableIPv4: Boolean? = null, val enableIPv6: Boolean? = null, val IPAM: IPAM? = null, val internal: Boolean? = false, val attachable: Boolean? = false, val ingress: Boolean? = false, val configFrom: ConfigReference? = null, val configOnly: Boolean? = false, val containers: Map<String, NetworkContainer>? = null, val options: Map<String, String>? = null, val labels: Map<String, String>? = null, val peers: List<PeerInfo>? = null)

Parameters

name

Name of the network.

ID that uniquely identifies a network on a single machine.

created

Date and time at which the network was created in RFC 3339 format with nano-seconds.

scope

The level at which the network exists (e.g. swarm for cluster-wide or local for machine level)

driver

The name of the driver used to create the network (e.g. bridge, overlay).

enableIPv4

Whether the network was created with IPv4 enabled.

enableIPv6

Whether the network was created with IPv6 enabled.

IPAM

`internal`

Whether the network is created to only allow internal networking connectivity.

attachable

Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode.

ingress

Whether the network is providing the routing-mesh for the swarm cluster.

configFrom

configOnly

Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services.

containers

Contains endpoints attached to the network.

options

Network-specific options uses when creating the network.

labels

User-defined key/value metadata.

peers

List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types.

Constructors

Network

constructor(name: String? = null, id: String? = null, created: String? = null, scope: String? = null, driver: String? = null, enableIPv4: Boolean? = null, enableIPv6: Boolean? = null, IPAM: IPAM? = null, internal: Boolean? = false, attachable: Boolean? = false, ingress: Boolean? = false, configFrom: ConfigReference? = null, configOnly: Boolean? = false, containers: Map<String, NetworkContainer>? = null, options: Map<String, String>? = null, labels: Map<String, String>? = null, peers: List<PeerInfo>? = null)