|
| 1 | +/** |
| 2 | +* Docker Engine API |
| 3 | +* 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...\" } ``` |
| 4 | +* |
| 5 | +* The version of the OpenAPI document: 1.41 |
| 6 | +* |
| 7 | +* |
| 8 | +* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). |
| 9 | +* https://openapi-generator.tech |
| 10 | +* Do not edit the class manually. |
| 11 | +*/ |
| 12 | +package de.gesellix.docker.engine.model |
| 13 | + |
| 14 | +import com.squareup.moshi.Json |
| 15 | +import com.squareup.moshi.JsonClass |
| 16 | + |
| 17 | +/** |
| 18 | + * |
| 19 | + * @param name The network's name. |
| 20 | + * @param checkDuplicate Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions. |
| 21 | + * @param driver Name of the network driver plugin to use. |
| 22 | + * @param `internal` Restrict external access to the network. |
| 23 | + * @param attachable Globally scoped network is manually attachable by regular containers from workers in swarm mode. |
| 24 | + * @param ingress Ingress network is the network which provides the routing-mesh in swarm mode. |
| 25 | + * @param IPAM |
| 26 | + * @param enableIPv6 Enable IPv6 on the network. |
| 27 | + * @param options Network specific options to be used by the drivers. |
| 28 | + * @param labels User-defined key/value metadata. |
| 29 | + */ |
| 30 | +@JsonClass(generateAdapter = true) |
| 31 | +data class NetworkCreateRequest( |
| 32 | + /* The network's name. */ |
| 33 | + @Json(name = "Name") |
| 34 | + val name: kotlin.String, |
| 35 | + /* Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions. */ |
| 36 | + @Json(name = "CheckDuplicate") |
| 37 | + val checkDuplicate: kotlin.Boolean? = null, |
| 38 | + /* Name of the network driver plugin to use. */ |
| 39 | + @Json(name = "Driver") |
| 40 | + val driver: kotlin.String? = null, |
| 41 | + /* Restrict external access to the network. */ |
| 42 | + @Json(name = "Internal") |
| 43 | + val `internal`: kotlin.Boolean? = null, |
| 44 | + /* Globally scoped network is manually attachable by regular containers from workers in swarm mode. */ |
| 45 | + @Json(name = "Attachable") |
| 46 | + val attachable: kotlin.Boolean? = null, |
| 47 | + /* Ingress network is the network which provides the routing-mesh in swarm mode. */ |
| 48 | + @Json(name = "Ingress") |
| 49 | + val ingress: kotlin.Boolean? = null, |
| 50 | + @Json(name = "IPAM") |
| 51 | + val IPAM: IPAM? = null, |
| 52 | + /* Enable IPv6 on the network. */ |
| 53 | + @Json(name = "EnableIPv6") |
| 54 | + val enableIPv6: kotlin.Boolean? = null, |
| 55 | + /* Network specific options to be used by the drivers. */ |
| 56 | + @Json(name = "Options") |
| 57 | + val options: kotlin.collections.Map<kotlin.String, kotlin.String>? = null, |
| 58 | + /* User-defined key/value metadata. */ |
| 59 | + @Json(name = "Labels") |
| 60 | + val labels: kotlin.collections.Map<kotlin.String, kotlin.String>? = null |
| 61 | +) |
0 commit comments