de.gesellix.docker.engine.model.NetworkSettings.kt Maven / Gradle / Ivy
/**
* Docker Engine API
* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ```
*
* The version of the OpenAPI document: 1.41
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package de.gesellix.docker.engine.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* NetworkSettings exposes the network settings in the API
* @param bridge Name of the network's bridge (for example, `docker0`).
* @param sandboxID SandboxID uniquely represents a container's network stack.
* @param hairpinMode Indicates if hairpin NAT should be enabled on the virtual interface.
* @param linkLocalIPv6Address IPv6 unicast address using the link-local prefix.
* @param linkLocalIPv6PrefixLen Prefix length of the IPv6 unicast address.
* @param ports PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table.
* @param sandboxKey SandboxKey identifies the sandbox
* @param secondaryIPAddresses
* @param secondaryIPv6Addresses
* @param endpointID EndpointID uniquely represents a service endpoint in a Sandbox.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param gateway Gateway address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param globalIPv6Address Global IPv6 address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param globalIPv6PrefixLen Mask length of the global IPv6 address.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param ipAddress IPv4 address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param ipPrefixLen Mask length of the IPv4 address.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param ipv6Gateway IPv6 gateway address for this network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param macAddress MAC address for the container on the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0
* @param networks Information about all networks that the container is connected to.
*/
@JsonClass(generateAdapter = true)
data class NetworkSettings(
/* Name of the network's bridge (for example, `docker0`). */
@Json(name = "Bridge")
val bridge: kotlin.String? = null,
/* SandboxID uniquely represents a container's network stack. */
@Json(name = "SandboxID")
val sandboxID: kotlin.String? = null,
/* Indicates if hairpin NAT should be enabled on the virtual interface. */
@Json(name = "HairpinMode")
val hairpinMode: kotlin.Boolean? = null,
/* IPv6 unicast address using the link-local prefix. */
@Json(name = "LinkLocalIPv6Address")
val linkLocalIPv6Address: kotlin.String? = null,
/* Prefix length of the IPv6 unicast address. */
@Json(name = "LinkLocalIPv6PrefixLen")
val linkLocalIPv6PrefixLen: kotlin.Int? = null,
/* PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. */
@Json(name = "Ports")
val ports: kotlin.collections.Map>? = null,
/* SandboxKey identifies the sandbox */
@Json(name = "SandboxKey")
val sandboxKey: kotlin.String? = null,
/* */
@Json(name = "SecondaryIPAddresses")
val secondaryIPAddresses: kotlin.collections.List? = null,
/* */
@Json(name = "SecondaryIPv6Addresses")
val secondaryIPv6Addresses: kotlin.collections.List? = null,
/* EndpointID uniquely represents a service endpoint in a Sandbox.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "EndpointID")
val endpointID: kotlin.String? = null,
/* Gateway address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "Gateway")
val gateway: kotlin.String? = null,
/* Global IPv6 address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "GlobalIPv6Address")
val globalIPv6Address: kotlin.String? = null,
/* Mask length of the global IPv6 address.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "GlobalIPv6PrefixLen")
val globalIPv6PrefixLen: kotlin.Int? = null,
/* IPv4 address for the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "IPAddress")
val ipAddress: kotlin.String? = null,
/* Mask length of the IPv4 address.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "IPPrefixLen")
val ipPrefixLen: kotlin.Int? = null,
/* IPv6 gateway address for this network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "IPv6Gateway")
val ipv6Gateway: kotlin.String? = null,
/* MAC address for the container on the default \"bridge\" network.
> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 */
@Json(name = "MacAddress")
val macAddress: kotlin.String? = null,
/* Information about all networks that the container is connected to. */
@Json(name = "Networks")
val networks: kotlin.collections.Map? = null
)
© 2015 - 2025 Weber Informatics LLC | Privacy Policy