Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* 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
*
*
* Please note:
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* Do not edit this file manually.
*/
@file:Suppress(
"ArrayInDataClass",
"EnumEntryName",
"RemoveRedundantQualifierName",
"UnusedImport"
)
package de.gesellix.docker.remote.api
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
*
*
* @param binds A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`.
* @param containerIDFile Path to a file where the container ID is written
* @param logConfig
* @param networkMode Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to.
* @param portBindings 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 restartPolicy
* @param autoRemove Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set.
* @param volumeDriver Driver that this container uses to mount volumes.
* @param volumesFrom A list of volumes to inherit from another container, specified in the form `[:]`.
* @param mounts Specification for mounts to be added to the container.
* @param capAdd A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'.
* @param capDrop A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'.
* @param cgroupnsMode cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration.
* @param dns A list of DNS servers for the container to use.
* @param dnsOptions A list of DNS options.
* @param dnsSearch A list of DNS search domains.
* @param extraHosts A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`.
* @param groupAdd A list of additional groups that the container process will run as.
* @param ipcMode IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration.
* @param cgroup Cgroup to use for the container.
* @param links A list of links for the container in the form `container_name:alias`.
* @param oomScoreAdj An integer value containing the score given to the container in order to tune OOM killer preferences.
* @param pidMode Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container
* @param privileged Gives the container full access to the host.
* @param publishAllPorts Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`.
* @param readonlyRootfs Mount the container's root filesystem as read only.
* @param securityOpt A list of string values to customize labels for MLS systems, such as SELinux.
* @param storageOpt Storage driver options for this container, in the form `{\"size\": \"120G\"}`.
* @param tmpfs A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ```
* @param utSMode UTS namespace to use for the container.
* @param usernsMode Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
* @param shmSize Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
* @param sysctls A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ```
* @param runtime Runtime to use with this container.
* @param consoleSize Initial console size, as an `[height, width]` array. (Windows only)
* @param isolation Isolation technology of the container. (Windows only)
* @param maskedPaths The list of paths to be masked inside the container (this overrides the default set of paths).
* @param readonlyPaths The list of paths to be set as read-only inside the container (this overrides the default set of paths).
*/
@JsonClass(generateAdapter = true)
data class HostConfigAllOf(
/* A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. */
@Json(name = "Binds")
var binds: kotlin.collections.MutableList? = null,
/* Path to a file where the container ID is written */
@Json(name = "ContainerIDFile")
var containerIDFile: kotlin.String? = null,
@Json(name = "LogConfig")
var logConfig: HostConfigAllOfLogConfig? = null,
/* Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to. */
@Json(name = "NetworkMode")
var networkMode: kotlin.String? = 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 = "PortBindings")
var portBindings: kotlin.collections.MutableMap>? = null,
@Json(name = "RestartPolicy")
var restartPolicy: RestartPolicy? = null,
/* Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. */
@Json(name = "AutoRemove")
var autoRemove: kotlin.Boolean? = null,
/* Driver that this container uses to mount volumes. */
@Json(name = "VolumeDriver")
var volumeDriver: kotlin.String? = null,
/* A list of volumes to inherit from another container, specified in the form `[:]`. */
@Json(name = "VolumesFrom")
var volumesFrom: kotlin.collections.MutableList? = null,
/* Specification for mounts to be added to the container. */
@Json(name = "Mounts")
var mounts: kotlin.collections.MutableList? = null,
/* A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. */
@Json(name = "CapAdd")
var capAdd: kotlin.collections.MutableList? = null,
/* A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. */
@Json(name = "CapDrop")
var capDrop: kotlin.collections.MutableList? = null,
/* cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. */
@Json(name = "CgroupnsMode")
var cgroupnsMode: HostConfigAllOf.CgroupnsMode? = null,
/* A list of DNS servers for the container to use. */
@Json(name = "Dns")
var dns: kotlin.collections.MutableList? = null,
/* A list of DNS options. */
@Json(name = "DnsOptions")
var dnsOptions: kotlin.collections.MutableList? = null,
/* A list of DNS search domains. */
@Json(name = "DnsSearch")
var dnsSearch: kotlin.collections.MutableList? = null,
/* A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. */
@Json(name = "ExtraHosts")
var extraHosts: kotlin.collections.MutableList? = null,
/* A list of additional groups that the container process will run as. */
@Json(name = "GroupAdd")
var groupAdd: kotlin.collections.MutableList? = null,
/* IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. */
@Json(name = "IpcMode")
var ipcMode: kotlin.String? = null,
/* Cgroup to use for the container. */
@Json(name = "Cgroup")
var cgroup: kotlin.String? = null,
/* A list of links for the container in the form `container_name:alias`. */
@Json(name = "Links")
var links: kotlin.collections.MutableList? = null,
/* An integer value containing the score given to the container in order to tune OOM killer preferences. */
@Json(name = "OomScoreAdj")
var oomScoreAdj: kotlin.Int? = null,
/* Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container */
@Json(name = "PidMode")
var pidMode: kotlin.String? = null,
/* Gives the container full access to the host. */
@Json(name = "Privileged")
var privileged: kotlin.Boolean? = null,
/* Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. */
@Json(name = "PublishAllPorts")
var publishAllPorts: kotlin.Boolean? = null,
/* Mount the container's root filesystem as read only. */
@Json(name = "ReadonlyRootfs")
var readonlyRootfs: kotlin.Boolean? = null,
/* A list of string values to customize labels for MLS systems, such as SELinux. */
@Json(name = "SecurityOpt")
var securityOpt: kotlin.collections.MutableList? = null,
/* Storage driver options for this container, in the form `{\"size\": \"120G\"}`. */
@Json(name = "StorageOpt")
var storageOpt: kotlin.collections.MutableMap? = null,
/* A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` */
@Json(name = "Tmpfs")
var tmpfs: kotlin.collections.MutableMap? = null,
/* UTS namespace to use for the container. */
@Json(name = "UTSMode")
var utSMode: kotlin.String? = null,
/* Sets the usernamespace mode for the container when usernamespace remapping option is enabled. */
@Json(name = "UsernsMode")
var usernsMode: kotlin.String? = null,
/* Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. */
@Json(name = "ShmSize")
var shmSize: kotlin.Int? = null,
/* A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` */
@Json(name = "Sysctls")
var sysctls: kotlin.collections.MutableMap? = null,
/* Runtime to use with this container. */
@Json(name = "Runtime")
var runtime: kotlin.String? = null,
/* Initial console size, as an `[height, width]` array. (Windows only) */
@Json(name = "ConsoleSize")
var consoleSize: kotlin.collections.MutableList? = null,
/* Isolation technology of the container. (Windows only) */
@Json(name = "Isolation")
var isolation: HostConfigAllOf.Isolation? = null,
/* The list of paths to be masked inside the container (this overrides the default set of paths). */
@Json(name = "MaskedPaths")
var maskedPaths: kotlin.collections.MutableList? = null,
/* The list of paths to be set as read-only inside the container (this overrides the default set of paths). */
@Json(name = "ReadonlyPaths")
var readonlyPaths: kotlin.collections.MutableList? = null
) {
/**
* cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration.
*
* Values: Private,Host
*/
enum class CgroupnsMode(val value: kotlin.String) {
@Json(name = "private") Private("private"),
@Json(name = "host") Host("host");
}
/**
* Isolation technology of the container. (Windows only)
*
* Values: Default,Process,Hyperv
*/
enum class Isolation(val value: kotlin.String) {
@Json(name = "default") Default("default"),
@Json(name = "process") Process("process"),
@Json(name = "hyperv") Hyperv("hyperv");
}
}
