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

EndpointSettings

@Serializable

data class EndpointSettings(val ipAMConfig: EndpointIPAMConfig? = null, val links: List<String>? = null, val macAddress: String? = null, val aliases: List<String>? = null, val driverOpts: Map<String, String>? = null, val gwPriority: Double? = null, val networkID: String? = null, val endpointID: String? = null, val gateway: String? = null, val ipAddress: String? = null, val ipPrefixLen: Int? = null, val ipv6Gateway: String? = null, val globalIPv6Address: String? = null, val globalIPv6PrefixLen: Long? = null, val dnSNames: List<String>? = null)

Configuration for a network endpoint.

Parameters

ipAMConfig

links

macAddress

MAC address for the endpoint on this network. The network driver might ignore this parameter.

aliases

driverOpts

DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.

gwPriority

This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked.

networkID

Unique ID of the network.

endpointID

Unique ID for the service endpoint in a Sandbox.

gateway

Gateway address for this network.

ipAddress

IPv4 address.

ipPrefixLen

Mask length of the IPv4 address.

ipv6Gateway

IPv6 gateway address.

globalIPv6Address

Global IPv6 address.

globalIPv6PrefixLen

Mask length of the global IPv6 address.

dnSNames

List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

Constructors

EndpointSettings

constructor(ipAMConfig: EndpointIPAMConfig? = null, links: List<String>? = null, macAddress: String? = null, aliases: List<String>? = null, driverOpts: Map<String, String>? = null, gwPriority: Double? = null, networkID: String? = null, endpointID: String? = null, gateway: String? = null, ipAddress: String? = null, ipPrefixLen: Int? = null, ipv6Gateway: String? = null, globalIPv6Address: String? = null, globalIPv6PrefixLen: Long? = null, dnSNames: List<String>? = null)