diff --git a/api-model-v1-41/.openapi-generator/VERSION b/api-model-v1-41/.openapi-generator/VERSION index 93c8ddab..1985849f 100644 --- a/api-model-v1-41/.openapi-generator/VERSION +++ b/api-model-v1-41/.openapi-generator/VERSION @@ -1 +1 @@ -7.6.0 +7.7.0 diff --git a/api-model-v1-41/README.md b/api-model-v1-41/README.md index 66a437a9..f7500798 100644 --- a/api-model-v1-41/README.md +++ b/api-model-v1-41/README.md @@ -78,7 +78,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: 1.41 - Package version: -- Generator version: 7.6.0 +- Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.KotlinClientCodegen ## Requires @@ -114,115 +114,115 @@ This runs all tests and packages the library. All URIs are relative to *http://localhost/v1.41* -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config -*ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config -*ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config -*ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs -*ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config -*ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container -*ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container -*ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container -*ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket -*ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem -*ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container -*ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container -*ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container -*ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container -*ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container -*ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers -*ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs -*ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container -*ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers -*ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container -*ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY -*ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container -*ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container -*ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage -*ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container -*ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container -*ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container -*ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container -*ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container -*ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container -*DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry -*ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance -*ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance -*ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance -*ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance -*ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache -*ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image -*ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container -*ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image -*ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image -*ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image -*ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images -*ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image -*ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image -*ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images -*ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images -*ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images -*ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image -*ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images -*ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image -*NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network -*NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network -*NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network -*NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network -*NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network -*NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks -*NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks -*NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node -*NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node -*NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes -*NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node -*PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges -*PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin -*PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin -*PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin -*PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin -*PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin -*PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins -*PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin -*PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin -*PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin -*PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin -*SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret -*SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret -*SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret -*SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets -*SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret -*ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service -*ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service -*ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service -*ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services -*ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs -*ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service -*SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session -*SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm -*SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm -*SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm -*SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm -*SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager -*SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key -*SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm -*SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration -*SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information -*SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events -*SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information -*SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping -*SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping -*SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version -*TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task -*TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks -*TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs -*VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume -*VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume -*VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume -*VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes -*VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes -*VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" +| Class | Method | HTTP request | Description | +| ------------ | ------------- | ------------- | ------------- | +| *ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config | +| *ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config | +| *ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config | +| *ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs | +| *ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config | +| *ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container | +| *ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container | +| *ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container | +| *ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket | +| *ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem | +| *ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container | +| *ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container | +| *ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container | +| *ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container | +| *ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container | +| *ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers | +| *ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs | +| *ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container | +| *ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers | +| *ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container | +| *ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY | +| *ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container | +| *ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container | +| *ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage | +| *ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container | +| *ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container | +| *ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container | +| *ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container | +| *ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container | +| *ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container | +| *DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry | +| *ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance | +| *ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance | +| *ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance | +| *ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance | +| *ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache | +| *ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image | +| *ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container | +| *ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image | +| *ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image | +| *ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image | +| *ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images | +| *ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image | +| *ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image | +| *ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images | +| *ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images | +| *ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images | +| *ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image | +| *ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images | +| *ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image | +| *NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network | +| *NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network | +| *NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network | +| *NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network | +| *NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network | +| *NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks | +| *NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks | +| *NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node | +| *NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node | +| *NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes | +| *NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node | +| *PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges | +| *PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin | +| *PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin | +| *PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin | +| *PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin | +| *PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin | +| *PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins | +| *PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin | +| *PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin | +| *PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin | +| *PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin | +| *SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret | +| *SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret | +| *SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret | +| *SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets | +| *SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret | +| *ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service | +| *ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service | +| *ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service | +| *ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services | +| *ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs | +| *ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service | +| *SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session | +| *SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm | +| *SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm | +| *SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm | +| *SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm | +| *SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager | +| *SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key | +| *SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm | +| *SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration | +| *SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information | +| *SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events | +| *SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information | +| *SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping | +| *SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping | +| *SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version | +| *TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task | +| *TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks | +| *TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs | +| *VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume | +| *VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume | +| *VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume | +| *VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes | +| *VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes | +| *VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" | diff --git a/api-model-v1-41/docs/Address.md b/api-model-v1-41/docs/Address.md index b34db1ad..0b2b6f74 100644 --- a/api-model-v1-41/docs/Address.md +++ b/api-model-v1-41/docs/Address.md @@ -2,10 +2,10 @@ # Address ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**addr** | **kotlin.String** | IP address. | [optional] -**prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **addr** | **kotlin.String** | IP address. | [optional] | +| **prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] | diff --git a/api-model-v1-41/docs/AuthConfig.md b/api-model-v1-41/docs/AuthConfig.md index f50a3d54..c9539dd7 100644 --- a/api-model-v1-41/docs/AuthConfig.md +++ b/api-model-v1-41/docs/AuthConfig.md @@ -2,12 +2,12 @@ # AuthConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**username** | **kotlin.String** | | [optional] -**password** | **kotlin.String** | | [optional] -**email** | **kotlin.String** | | [optional] -**serveraddress** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **username** | **kotlin.String** | | [optional] | +| **password** | **kotlin.String** | | [optional] | +| **email** | **kotlin.String** | | [optional] | +| **serveraddress** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/BuildCache.md b/api-model-v1-41/docs/BuildCache.md index a1421c37..719351e8 100644 --- a/api-model-v1-41/docs/BuildCache.md +++ b/api-model-v1-41/docs/BuildCache.md @@ -2,26 +2,26 @@ # BuildCache ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] -**parent** | **kotlin.String** | ID of the parent build cache record. > **Deprecated**: This field is deprecated, and omitted if empty. | [optional] -**parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] -**type** | [**inline**](#Type) | Cache record type. | [optional] -**description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] -**inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] -**shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] -**propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] -**createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**usageCount** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] | +| **parent** | **kotlin.String** | ID of the parent build cache record. > **Deprecated**: This field is deprecated, and omitted if empty. | [optional] | +| **parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] | +| **type** | [**inline**](#Type) | Cache record type. | [optional] | +| **description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] | +| **inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] | +| **shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] | +| **propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **usageCount** | **kotlin.Int** | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular +| Name | Value | +| ---- | ----- | +| type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular | diff --git a/api-model-v1-41/docs/BuildInfo.md b/api-model-v1-41/docs/BuildInfo.md index 00f51c03..7adad3f3 100644 --- a/api-model-v1-41/docs/BuildInfo.md +++ b/api-model-v1-41/docs/BuildInfo.md @@ -2,16 +2,16 @@ # BuildInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | [optional] -**stream** | **kotlin.String** | | [optional] -**error** | **kotlin.String** | | [optional] -**errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] -**aux** | [**ImageID**](ImageID.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **stream** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | +| **aux** | [**ImageID**](ImageID.md) | | [optional] | diff --git a/api-model-v1-41/docs/BuildPruneResponse.md b/api-model-v1-41/docs/BuildPruneResponse.md index 34efd422..99595843 100644 --- a/api-model-v1-41/docs/BuildPruneResponse.md +++ b/api-model-v1-41/docs/BuildPruneResponse.md @@ -2,10 +2,10 @@ # BuildPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-41/docs/ClusterInfo.md b/api-model-v1-41/docs/ClusterInfo.md index 1f70cac7..c7f6c112 100644 --- a/api-model-v1-41/docs/ClusterInfo.md +++ b/api-model-v1-41/docs/ClusterInfo.md @@ -2,18 +2,18 @@ # ClusterInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the swarm. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] -**rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolume.md b/api-model-v1-41/docs/ClusterVolume.md index 85ef2a29..da0a33cf 100644 --- a/api-model-v1-41/docs/ClusterVolume.md +++ b/api-model-v1-41/docs/ClusterVolume.md @@ -2,15 +2,15 @@ # ClusterVolume ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] -**info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] -**publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | +| **info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] | +| **publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolumeInfo.md b/api-model-v1-41/docs/ClusterVolumeInfo.md index 88fe512b..55fef034 100644 --- a/api-model-v1-41/docs/ClusterVolumeInfo.md +++ b/api-model-v1-41/docs/ClusterVolumeInfo.md @@ -2,12 +2,12 @@ # ClusterVolumeInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] -**volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] -**volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] -**accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] | +| **volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] | +| **volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] | +| **accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolumePublishStatusInner.md b/api-model-v1-41/docs/ClusterVolumePublishStatusInner.md index 7d3823c3..96142792 100644 --- a/api-model-v1-41/docs/ClusterVolumePublishStatusInner.md +++ b/api-model-v1-41/docs/ClusterVolumePublishStatusInner.md @@ -2,18 +2,18 @@ # ClusterVolumePublishStatusInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] -**state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] -**publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] | +| **state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] | +| **publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] | ## Enum: State -Name | Value ----- | ----- -state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish +| Name | Value | +| ---- | ----- | +| state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish | diff --git a/api-model-v1-41/docs/ClusterVolumeSpec.md b/api-model-v1-41/docs/ClusterVolumeSpec.md index 81fc4829..670b70e0 100644 --- a/api-model-v1-41/docs/ClusterVolumeSpec.md +++ b/api-model-v1-41/docs/ClusterVolumeSpec.md @@ -2,10 +2,10 @@ # ClusterVolumeSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] -**accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] | +| **accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolumeSpecAccessMode.md b/api-model-v1-41/docs/ClusterVolumeSpecAccessMode.md index 7fe2e4c5..37eb7734 100644 --- a/api-model-v1-41/docs/ClusterVolumeSpecAccessMode.md +++ b/api-model-v1-41/docs/ClusterVolumeSpecAccessMode.md @@ -2,36 +2,36 @@ # ClusterVolumeSpecAccessMode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] -**sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] -**mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] -**secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] -**accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] -**capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] -**availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] | +| **sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] | +| **mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] | +| **secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] | +| **accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] | +| **capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] | +| **availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] | ## Enum: Scope -Name | Value ----- | ----- -scope | single, multi +| Name | Value | +| ---- | ----- | +| scope | single, multi | ## Enum: Sharing -Name | Value ----- | ----- -sharing | none, readonly, onewriter, all +| Name | Value | +| ---- | ----- | +| sharing | none, readonly, onewriter, all | ## Enum: Availability -Name | Value ----- | ----- -availability | active, pause, drain +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | diff --git a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md index 1b25bf93..fe071a5d 100644 --- a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md +++ b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeAccessibilityRequirements ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] -**preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] | +| **preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeCapacityRange.md b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeCapacityRange.md index 1dcceba8..6ed01224 100644 --- a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeCapacityRange.md +++ b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeCapacityRange.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeCapacityRange ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] -**limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] | +| **limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] | diff --git a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeSecretsInner.md b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeSecretsInner.md index 92397c7b..608a6876 100644 --- a/api-model-v1-41/docs/ClusterVolumeSpecAccessModeSecretsInner.md +++ b/api-model-v1-41/docs/ClusterVolumeSpecAccessModeSecretsInner.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeSecretsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] -**secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] | +| **secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] | diff --git a/api-model-v1-41/docs/Commit.md b/api-model-v1-41/docs/Commit.md index 142fab5d..db8ec2f9 100644 --- a/api-model-v1-41/docs/Commit.md +++ b/api-model-v1-41/docs/Commit.md @@ -2,10 +2,10 @@ # Commit ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] -**expected** | **kotlin.String** | Commit ID of external tool expected by dockerd as set at build time. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] | +| **expected** | **kotlin.String** | Commit ID of external tool expected by dockerd as set at build time. | [optional] | diff --git a/api-model-v1-41/docs/Config.md b/api-model-v1-41/docs/Config.md index bcc9d623..5174c406 100644 --- a/api-model-v1-41/docs/Config.md +++ b/api-model-v1-41/docs/Config.md @@ -2,13 +2,13 @@ # Config ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/ConfigCreateRequest.md b/api-model-v1-41/docs/ConfigCreateRequest.md index fe14855f..b237b0d5 100644 --- a/api-model-v1-41/docs/ConfigCreateRequest.md +++ b/api-model-v1-41/docs/ConfigCreateRequest.md @@ -2,12 +2,12 @@ # ConfigCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the config. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-41/docs/ConfigSpec.md b/api-model-v1-41/docs/ConfigSpec.md index 2def499f..4846145d 100644 --- a/api-model-v1-41/docs/ConfigSpec.md +++ b/api-model-v1-41/docs/ConfigSpec.md @@ -2,12 +2,12 @@ # ConfigSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the config. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerConfig.md b/api-model-v1-41/docs/ContainerConfig.md index 91eba8cf..06a2c65b 100644 --- a/api-model-v1-41/docs/ContainerConfig.md +++ b/api-model-v1-41/docs/ContainerConfig.md @@ -2,33 +2,33 @@ # ContainerConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] -**domainname** | **kotlin.String** | The domain name to use for the container. | [optional] -**user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] -**attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] -**attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] -**attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] -**exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] -**tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] -**healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] -**image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] -**volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] -**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] -**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] -**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] -**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] -**stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] -**shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | diff --git a/api-model-v1-41/docs/ContainerCreateRequest.md b/api-model-v1-41/docs/ContainerCreateRequest.md index 1231ac50..14e964f9 100644 --- a/api-model-v1-41/docs/ContainerCreateRequest.md +++ b/api-model-v1-41/docs/ContainerCreateRequest.md @@ -2,35 +2,35 @@ # ContainerCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] -**domainname** | **kotlin.String** | The domain name to use for the container. | [optional] -**user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] -**attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] -**attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] -**attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] -**exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] -**tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] -**healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] -**image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] -**volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] -**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] -**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] -**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] -**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] -**stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] -**shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] -**hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] -**networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerCreateResponse.md b/api-model-v1-41/docs/ContainerCreateResponse.md index 3c3788da..2470f713 100644 --- a/api-model-v1-41/docs/ContainerCreateResponse.md +++ b/api-model-v1-41/docs/ContainerCreateResponse.md @@ -2,10 +2,10 @@ # ContainerCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the created container | -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created container | | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] | diff --git a/api-model-v1-41/docs/ContainerInspectResponse.md b/api-model-v1-41/docs/ContainerInspectResponse.md index 69344bc7..f4cf96a4 100644 --- a/api-model-v1-41/docs/ContainerInspectResponse.md +++ b/api-model-v1-41/docs/ContainerInspectResponse.md @@ -2,33 +2,33 @@ # ContainerInspectResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the container | [optional] -**created** | **kotlin.String** | The time the container was created | [optional] -**path** | **kotlin.String** | The path to the command being run | [optional] -**args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] -**state** | [**ContainerState**](ContainerState.md) | | [optional] -**image** | **kotlin.String** | The container's image ID | [optional] -**resolvConfPath** | **kotlin.String** | | [optional] -**hostnamePath** | **kotlin.String** | | [optional] -**hostsPath** | **kotlin.String** | | [optional] -**logPath** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | | [optional] -**restartCount** | **kotlin.Int** | | [optional] -**driver** | **kotlin.String** | | [optional] -**platform** | **kotlin.String** | | [optional] -**mountLabel** | **kotlin.String** | | [optional] -**processLabel** | **kotlin.String** | | [optional] -**appArmorProfile** | **kotlin.String** | | [optional] -**execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] -**hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] -**graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] -**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. | [optional] -**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container. | [optional] -**mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] -**config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the container | [optional] | +| **created** | **kotlin.String** | The time the container was created | [optional] | +| **path** | **kotlin.String** | The path to the command being run | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] | +| **state** | [**ContainerState**](ContainerState.md) | | [optional] | +| **image** | **kotlin.String** | The container's image ID | [optional] | +| **resolvConfPath** | **kotlin.String** | | [optional] | +| **hostnamePath** | **kotlin.String** | | [optional] | +| **hostsPath** | **kotlin.String** | | [optional] | +| **logPath** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **restartCount** | **kotlin.Int** | | [optional] | +| **driver** | **kotlin.String** | | [optional] | +| **platform** | **kotlin.String** | | [optional] | +| **mountLabel** | **kotlin.String** | | [optional] | +| **processLabel** | **kotlin.String** | | [optional] | +| **appArmorProfile** | **kotlin.String** | | [optional] | +| **execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all the files in this container. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerPruneResponse.md b/api-model-v1-41/docs/ContainerPruneResponse.md index 6b259d16..d498e282 100644 --- a/api-model-v1-41/docs/ContainerPruneResponse.md +++ b/api-model-v1-41/docs/ContainerPruneResponse.md @@ -2,10 +2,10 @@ # ContainerPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-41/docs/ContainerState.md b/api-model-v1-41/docs/ContainerState.md index 50cb7bd5..85d232e5 100644 --- a/api-model-v1-41/docs/ContainerState.md +++ b/api-model-v1-41/docs/ContainerState.md @@ -2,27 +2,27 @@ # ContainerState ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] -**running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] -**paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] -**restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] -**ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] -**dead** | **kotlin.Boolean** | | [optional] -**pid** | **kotlin.Int** | The process ID of this container | [optional] -**exitCode** | **kotlin.Int** | The last exit code of this container | [optional] -**error** | **kotlin.String** | | [optional] -**startedAt** | **kotlin.String** | The time when this container was last started. | [optional] -**finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] -**health** | [**Health**](Health.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] | +| **running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] | +| **paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] | +| **restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] | +| **ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] | +| **dead** | **kotlin.Boolean** | | [optional] | +| **pid** | **kotlin.Int** | The process ID of this container | [optional] | +| **exitCode** | **kotlin.Int** | The last exit code of this container | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **startedAt** | **kotlin.String** | The time when this container was last started. | [optional] | +| **finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] | +| **health** | [**Health**](Health.md) | | [optional] | ## Enum: Status -Name | Value ----- | ----- -status | created, running, paused, restarting, removing, exited, dead +| Name | Value | +| ---- | ----- | +| status | created, running, paused, restarting, removing, exited, dead | diff --git a/api-model-v1-41/docs/ContainerStatus.md b/api-model-v1-41/docs/ContainerStatus.md index e02765e7..b58e6e86 100644 --- a/api-model-v1-41/docs/ContainerStatus.md +++ b/api-model-v1-41/docs/ContainerStatus.md @@ -2,11 +2,11 @@ # ContainerStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containerID** | **kotlin.String** | | [optional] -**PID** | **kotlin.Int** | | [optional] -**exitCode** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | | [optional] | +| **PID** | **kotlin.Int** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/ContainerSummary.md b/api-model-v1-41/docs/ContainerSummary.md index 86afc47d..0701022d 100644 --- a/api-model-v1-41/docs/ContainerSummary.md +++ b/api-model-v1-41/docs/ContainerSummary.md @@ -2,23 +2,23 @@ # ContainerSummary ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of this container | [optional] -**names** | **kotlin.collections.MutableList<kotlin.String>** | The names that this container has been given | [optional] -**image** | **kotlin.String** | The name of the image used when creating this container | [optional] -**imageID** | **kotlin.String** | The ID of the image that this container was created from | [optional] -**command** | **kotlin.String** | Command to run when starting the container | [optional] -**created** | **kotlin.Long** | When the container was created | [optional] -**ports** | [**kotlin.collections.MutableList<Port>**](Port.md) | The ports exposed by this container | [optional] -**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container | [optional] -**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**state** | **kotlin.String** | The state of this container (e.g. `Exited`) | [optional] -**status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) | [optional] -**hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) | | [optional] -**networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) | | [optional] -**mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of this container | [optional] | +| **names** | **kotlin.collections.MutableList<kotlin.String>** | The names that this container has been given | [optional] | +| **image** | **kotlin.String** | The name of the image used when creating this container | [optional] | +| **imageID** | **kotlin.String** | The ID of the image that this container was created from | [optional] | +| **command** | **kotlin.String** | Command to run when starting the container | [optional] | +| **created** | **kotlin.Long** | When the container was created | [optional] | +| **ports** | [**kotlin.collections.MutableList<Port>**](Port.md) | The ports exposed by this container | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all the files in this container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **state** | **kotlin.String** | The state of this container (e.g. `Exited`) | [optional] | +| **status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) | [optional] | +| **hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) | | [optional] | +| **networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) | | [optional] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerSummaryHostConfig.md b/api-model-v1-41/docs/ContainerSummaryHostConfig.md index 165a27a8..646ecc02 100644 --- a/api-model-v1-41/docs/ContainerSummaryHostConfig.md +++ b/api-model-v1-41/docs/ContainerSummaryHostConfig.md @@ -2,9 +2,9 @@ # ContainerSummaryHostConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networkMode** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkMode** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md b/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md index acb7fec6..976bd525 100644 --- a/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md +++ b/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md @@ -2,9 +2,9 @@ # ContainerSummaryNetworkSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerTopResponse.md b/api-model-v1-41/docs/ContainerTopResponse.md index ef42e8be..2be83bc3 100644 --- a/api-model-v1-41/docs/ContainerTopResponse.md +++ b/api-model-v1-41/docs/ContainerTopResponse.md @@ -2,10 +2,10 @@ # ContainerTopResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] -**processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] | +| **processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] | diff --git a/api-model-v1-41/docs/ContainerUpdateRequest.md b/api-model-v1-41/docs/ContainerUpdateRequest.md index 8afa71a5..44b57d97 100644 --- a/api-model-v1-41/docs/ContainerUpdateRequest.md +++ b/api-model-v1-41/docs/ContainerUpdateRequest.md @@ -2,40 +2,40 @@ # ContainerUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] -**restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | diff --git a/api-model-v1-41/docs/ContainerUpdateResponse.md b/api-model-v1-41/docs/ContainerUpdateResponse.md index 067f8a6f..d8314d37 100644 --- a/api-model-v1-41/docs/ContainerUpdateResponse.md +++ b/api-model-v1-41/docs/ContainerUpdateResponse.md @@ -2,9 +2,9 @@ # ContainerUpdateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/ContainerWaitExitError.md b/api-model-v1-41/docs/ContainerWaitExitError.md index 9891f878..42bceba4 100644 --- a/api-model-v1-41/docs/ContainerWaitExitError.md +++ b/api-model-v1-41/docs/ContainerWaitExitError.md @@ -2,9 +2,9 @@ # ContainerWaitExitError ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **kotlin.String** | Details of an error | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | Details of an error | [optional] | diff --git a/api-model-v1-41/docs/ContainerWaitResponse.md b/api-model-v1-41/docs/ContainerWaitResponse.md index 61ccd4a9..8e2eea9b 100644 --- a/api-model-v1-41/docs/ContainerWaitResponse.md +++ b/api-model-v1-41/docs/ContainerWaitResponse.md @@ -2,10 +2,10 @@ # ContainerWaitResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**statusCode** | **kotlin.Long** | Exit code of the container | -**error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **statusCode** | **kotlin.Long** | Exit code of the container | | +| **error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] | diff --git a/api-model-v1-41/docs/CreateImageInfo.md b/api-model-v1-41/docs/CreateImageInfo.md index c3f1a7fd..1672d321 100644 --- a/api-model-v1-41/docs/CreateImageInfo.md +++ b/api-model-v1-41/docs/CreateImageInfo.md @@ -2,14 +2,14 @@ # CreateImageInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | [optional] -**error** | **kotlin.String** | | [optional] -**errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | diff --git a/api-model-v1-41/docs/DeviceMapping.md b/api-model-v1-41/docs/DeviceMapping.md index a229d63a..d90a503a 100644 --- a/api-model-v1-41/docs/DeviceMapping.md +++ b/api-model-v1-41/docs/DeviceMapping.md @@ -2,11 +2,11 @@ # DeviceMapping ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pathOnHost** | **kotlin.String** | | [optional] -**pathInContainer** | **kotlin.String** | | [optional] -**cgroupPermissions** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pathOnHost** | **kotlin.String** | | [optional] | +| **pathInContainer** | **kotlin.String** | | [optional] | +| **cgroupPermissions** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/DeviceRequest.md b/api-model-v1-41/docs/DeviceRequest.md index d481fa41..e54c22ac 100644 --- a/api-model-v1-41/docs/DeviceRequest.md +++ b/api-model-v1-41/docs/DeviceRequest.md @@ -2,13 +2,13 @@ # DeviceRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**driver** | **kotlin.String** | | [optional] -**count** | **kotlin.Int** | | [optional] -**deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | | [optional] | +| **count** | **kotlin.Int** | | [optional] | +| **deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] | diff --git a/api-model-v1-41/docs/DistributionInspect.md b/api-model-v1-41/docs/DistributionInspect.md index 15df91fd..fef111c5 100644 --- a/api-model-v1-41/docs/DistributionInspect.md +++ b/api-model-v1-41/docs/DistributionInspect.md @@ -2,10 +2,10 @@ # DistributionInspect ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | -**platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | | +| **platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | | diff --git a/api-model-v1-41/docs/Driver.md b/api-model-v1-41/docs/Driver.md index 51c7a732..1d98106e 100644 --- a/api-model-v1-41/docs/Driver.md +++ b/api-model-v1-41/docs/Driver.md @@ -2,10 +2,10 @@ # Driver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the driver. | -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] | diff --git a/api-model-v1-41/docs/EndpointIPAMConfig.md b/api-model-v1-41/docs/EndpointIPAMConfig.md index f3a57409..f12793e4 100644 --- a/api-model-v1-41/docs/EndpointIPAMConfig.md +++ b/api-model-v1-41/docs/EndpointIPAMConfig.md @@ -2,11 +2,11 @@ # EndpointIPAMConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipv4Address** | **kotlin.String** | | [optional] -**ipv6Address** | **kotlin.String** | | [optional] -**linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | +| **linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/EndpointPortConfig.md b/api-model-v1-41/docs/EndpointPortConfig.md index c37f35dd..6dc393a5 100644 --- a/api-model-v1-41/docs/EndpointPortConfig.md +++ b/api-model-v1-41/docs/EndpointPortConfig.md @@ -2,27 +2,27 @@ # EndpointPortConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**protocol** | [**inline**](#Protocol) | | [optional] -**targetPort** | **kotlin.Int** | The port inside the container. | [optional] -**publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] -**publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **protocol** | [**inline**](#Protocol) | | [optional] | +| **targetPort** | **kotlin.Int** | The port inside the container. | [optional] | +| **publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] | +| **publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] | ## Enum: Protocol -Name | Value ----- | ----- -protocol | tcp, udp, sctp +| Name | Value | +| ---- | ----- | +| protocol | tcp, udp, sctp | ## Enum: PublishMode -Name | Value ----- | ----- -publishMode | ingress, host +| Name | Value | +| ---- | ----- | +| publishMode | ingress, host | diff --git a/api-model-v1-41/docs/EndpointSettings.md b/api-model-v1-41/docs/EndpointSettings.md index d3f595e9..22da10dd 100644 --- a/api-model-v1-41/docs/EndpointSettings.md +++ b/api-model-v1-41/docs/EndpointSettings.md @@ -2,21 +2,21 @@ # EndpointSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] -**links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] -**aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**networkID** | **kotlin.String** | Unique ID of the network. | [optional] -**endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] -**gateway** | **kotlin.String** | Gateway address for this network. | [optional] -**ipAddress** | **kotlin.String** | IPv4 address. | [optional] -**ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] -**ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] -**globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] -**globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **networkID** | **kotlin.String** | Unique ID of the network. | [optional] | +| **endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] | +| **gateway** | **kotlin.String** | Gateway address for this network. | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address. | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | diff --git a/api-model-v1-41/docs/EndpointSpec.md b/api-model-v1-41/docs/EndpointSpec.md index 2e25afc1..9b02a1e3 100644 --- a/api-model-v1-41/docs/EndpointSpec.md +++ b/api-model-v1-41/docs/EndpointSpec.md @@ -2,17 +2,17 @@ # EndpointSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] | ## Enum: Mode -Name | Value ----- | ----- -mode | vip, dnsrr +| Name | Value | +| ---- | ----- | +| mode | vip, dnsrr | diff --git a/api-model-v1-41/docs/EngineDescription.md b/api-model-v1-41/docs/EngineDescription.md index 07445e46..c9abe8ae 100644 --- a/api-model-v1-41/docs/EngineDescription.md +++ b/api-model-v1-41/docs/EngineDescription.md @@ -2,11 +2,11 @@ # EngineDescription ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**engineVersion** | **kotlin.String** | | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] -**plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **engineVersion** | **kotlin.String** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] | diff --git a/api-model-v1-41/docs/EngineDescriptionPluginsInner.md b/api-model-v1-41/docs/EngineDescriptionPluginsInner.md index b2a8035c..53229a1d 100644 --- a/api-model-v1-41/docs/EngineDescriptionPluginsInner.md +++ b/api-model-v1-41/docs/EngineDescriptionPluginsInner.md @@ -2,10 +2,10 @@ # EngineDescriptionPluginsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/ErrorDetail.md b/api-model-v1-41/docs/ErrorDetail.md index c6d3457d..d909c08f 100644 --- a/api-model-v1-41/docs/ErrorDetail.md +++ b/api-model-v1-41/docs/ErrorDetail.md @@ -2,10 +2,10 @@ # ErrorDetail ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **kotlin.Int** | | [optional] -**message** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **code** | **kotlin.Int** | | [optional] | +| **message** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/ErrorResponse.md b/api-model-v1-41/docs/ErrorResponse.md index 302e2626..24722b5a 100644 --- a/api-model-v1-41/docs/ErrorResponse.md +++ b/api-model-v1-41/docs/ErrorResponse.md @@ -2,9 +2,9 @@ # ErrorResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **kotlin.String** | The error message. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | The error message. | | diff --git a/api-model-v1-41/docs/EventActor.md b/api-model-v1-41/docs/EventActor.md index 24e06ef9..62eadd88 100644 --- a/api-model-v1-41/docs/EventActor.md +++ b/api-model-v1-41/docs/EventActor.md @@ -2,10 +2,10 @@ # EventActor ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the object emitting the event | [optional] -**attributes** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the object emitting the event | [optional] | +| **attributes** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] | diff --git a/api-model-v1-41/docs/EventMessage.md b/api-model-v1-41/docs/EventMessage.md index 15c6cd6c..30e7daf3 100644 --- a/api-model-v1-41/docs/EventMessage.md +++ b/api-model-v1-41/docs/EventMessage.md @@ -2,28 +2,28 @@ # EventMessage ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | The type of object emitting the event | [optional] -**action** | **kotlin.String** | The type of event | [optional] -**actor** | [**EventActor**](EventActor.md) | | [optional] -**scope** | [**inline**](#Scope) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional] -**time** | **kotlin.Long** | Timestamp of event | [optional] -**timeNano** | **kotlin.Long** | Timestamp of event, with nanosecond accuracy | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The type of object emitting the event | [optional] | +| **action** | **kotlin.String** | The type of event | [optional] | +| **actor** | [**EventActor**](EventActor.md) | | [optional] | +| **scope** | [**inline**](#Scope) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional] | +| **time** | **kotlin.Long** | Timestamp of event | [optional] | +| **timeNano** | **kotlin.Long** | Timestamp of event, with nanosecond accuracy | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | builder, config, container, daemon, image, network, node, plugin, secret, service, volume +| Name | Value | +| ---- | ----- | +| type | builder, config, container, daemon, image, network, node, plugin, secret, service, volume | ## Enum: scope -Name | Value ----- | ----- -scope | local, swarm +| Name | Value | +| ---- | ----- | +| scope | local, swarm | diff --git a/api-model-v1-41/docs/ExecConfig.md b/api-model-v1-41/docs/ExecConfig.md index b505238e..29f9dea7 100644 --- a/api-model-v1-41/docs/ExecConfig.md +++ b/api-model-v1-41/docs/ExecConfig.md @@ -2,19 +2,19 @@ # ExecConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachStdin** | **kotlin.Boolean** | Attach to `stdin` of the exec command. | [optional] -**attachStdout** | **kotlin.Boolean** | Attach to `stdout` of the exec command. | [optional] -**attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] -**detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] -**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run, as a string or array of strings. | [optional] -**privileged** | **kotlin.Boolean** | Runs the exec process with extended privileges. | [optional] -**user** | **kotlin.String** | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional] -**workingDir** | **kotlin.String** | The working directory for the exec process inside the container. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **attachStdin** | **kotlin.Boolean** | Attach to `stdin` of the exec command. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Attach to `stdout` of the exec command. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run, as a string or array of strings. | [optional] | +| **privileged** | **kotlin.Boolean** | Runs the exec process with extended privileges. | [optional] | +| **user** | **kotlin.String** | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for the exec process inside the container. | [optional] | diff --git a/api-model-v1-41/docs/ExecInspectResponse.md b/api-model-v1-41/docs/ExecInspectResponse.md index 2d5c4658..17dac875 100644 --- a/api-model-v1-41/docs/ExecInspectResponse.md +++ b/api-model-v1-41/docs/ExecInspectResponse.md @@ -2,19 +2,19 @@ # ExecInspectResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**canRemove** | **kotlin.Boolean** | | [optional] -**detachKeys** | **kotlin.String** | | [optional] -**ID** | **kotlin.String** | | [optional] -**running** | **kotlin.Boolean** | | [optional] -**exitCode** | **kotlin.Int** | | [optional] -**processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] -**openStdin** | **kotlin.Boolean** | | [optional] -**openStderr** | **kotlin.Boolean** | | [optional] -**openStdout** | **kotlin.Boolean** | | [optional] -**containerID** | **kotlin.String** | | [optional] -**pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **canRemove** | **kotlin.Boolean** | | [optional] | +| **detachKeys** | **kotlin.String** | | [optional] | +| **ID** | **kotlin.String** | | [optional] | +| **running** | **kotlin.Boolean** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | +| **processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] | +| **openStdin** | **kotlin.Boolean** | | [optional] | +| **openStderr** | **kotlin.Boolean** | | [optional] | +| **openStdout** | **kotlin.Boolean** | | [optional] | +| **containerID** | **kotlin.String** | | [optional] | +| **pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] | diff --git a/api-model-v1-41/docs/ExecStartConfig.md b/api-model-v1-41/docs/ExecStartConfig.md index 11b32c82..8553f097 100644 --- a/api-model-v1-41/docs/ExecStartConfig.md +++ b/api-model-v1-41/docs/ExecStartConfig.md @@ -2,11 +2,11 @@ # ExecStartConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detach** | **kotlin.Boolean** | Detach from the command. | [optional] -**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **detach** | **kotlin.Boolean** | Detach from the command. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | diff --git a/api-model-v1-41/docs/FilesystemChange.md b/api-model-v1-41/docs/FilesystemChange.md index 0dce49dc..8354bea7 100644 --- a/api-model-v1-41/docs/FilesystemChange.md +++ b/api-model-v1-41/docs/FilesystemChange.md @@ -2,10 +2,10 @@ # FilesystemChange ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Path to file or directory that has changed. | -**kind** | [**ChangeType**](ChangeType.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Path to file or directory that has changed. | | +| **kind** | [**ChangeType**](ChangeType.md) | | | diff --git a/api-model-v1-41/docs/GenericResourcesInner.md b/api-model-v1-41/docs/GenericResourcesInner.md index 7e222a3e..0019d861 100644 --- a/api-model-v1-41/docs/GenericResourcesInner.md +++ b/api-model-v1-41/docs/GenericResourcesInner.md @@ -2,10 +2,10 @@ # GenericResourcesInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] -**discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] | +| **discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/GenericResourcesInnerDiscreteResourceSpec.md b/api-model-v1-41/docs/GenericResourcesInnerDiscreteResourceSpec.md index d19edea6..0b8faebe 100644 --- a/api-model-v1-41/docs/GenericResourcesInnerDiscreteResourceSpec.md +++ b/api-model-v1-41/docs/GenericResourcesInnerDiscreteResourceSpec.md @@ -2,10 +2,10 @@ # GenericResourcesInnerDiscreteResourceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kind** | **kotlin.String** | | [optional] -**`value`** | **kotlin.Long** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.Long** | | [optional] | diff --git a/api-model-v1-41/docs/GenericResourcesInnerNamedResourceSpec.md b/api-model-v1-41/docs/GenericResourcesInnerNamedResourceSpec.md index 75459921..0f5ec50d 100644 --- a/api-model-v1-41/docs/GenericResourcesInnerNamedResourceSpec.md +++ b/api-model-v1-41/docs/GenericResourcesInnerNamedResourceSpec.md @@ -2,10 +2,10 @@ # GenericResourcesInnerNamedResourceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kind** | **kotlin.String** | | [optional] -**`value`** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/GraphDriverData.md b/api-model-v1-41/docs/GraphDriverData.md index fe55e829..448e627c 100644 --- a/api-model-v1-41/docs/GraphDriverData.md +++ b/api-model-v1-41/docs/GraphDriverData.md @@ -2,10 +2,10 @@ # GraphDriverData ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the storage driver. | -**`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the storage driver. | | +| **`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] | diff --git a/api-model-v1-41/docs/Health.md b/api-model-v1-41/docs/Health.md index ea9667ac..e888268e 100644 --- a/api-model-v1-41/docs/Health.md +++ b/api-model-v1-41/docs/Health.md @@ -2,18 +2,18 @@ # Health ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] -**failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] -**log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] | +| **failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] | +| **log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] | ## Enum: Status -Name | Value ----- | ----- -status | none, starting, healthy, unhealthy +| Name | Value | +| ---- | ----- | +| status | none, starting, healthy, unhealthy | diff --git a/api-model-v1-41/docs/HealthConfig.md b/api-model-v1-41/docs/HealthConfig.md index 64bb021d..a6d4e19c 100644 --- a/api-model-v1-41/docs/HealthConfig.md +++ b/api-model-v1-41/docs/HealthConfig.md @@ -2,14 +2,14 @@ # HealthConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] -**interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] -**startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] | +| **interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] | +| **startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | diff --git a/api-model-v1-41/docs/HealthcheckResult.md b/api-model-v1-41/docs/HealthcheckResult.md index 1d5a3cf4..1f0ab025 100644 --- a/api-model-v1-41/docs/HealthcheckResult.md +++ b/api-model-v1-41/docs/HealthcheckResult.md @@ -2,12 +2,12 @@ # HealthcheckResult ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] -**output** | **kotlin.String** | Output from last check | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] | +| **output** | **kotlin.String** | Output from last check | [optional] | diff --git a/api-model-v1-41/docs/HistoryResponseItem.md b/api-model-v1-41/docs/HistoryResponseItem.md index 20db3fff..dbbce217 100644 --- a/api-model-v1-41/docs/HistoryResponseItem.md +++ b/api-model-v1-41/docs/HistoryResponseItem.md @@ -2,14 +2,14 @@ # HistoryResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | -**created** | **kotlin.Long** | | -**createdBy** | **kotlin.String** | | -**tags** | **kotlin.collections.MutableList<kotlin.String>** | | -**propertySize** | **kotlin.Long** | | -**comment** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | | +| **created** | **kotlin.Long** | | | +| **createdBy** | **kotlin.String** | | | +| **tags** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **propertySize** | **kotlin.Long** | | | +| **comment** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/HostConfig.md b/api-model-v1-41/docs/HostConfig.md index cc537e23..88bdce08 100644 --- a/api-model-v1-41/docs/HostConfig.md +++ b/api-model-v1-41/docs/HostConfig.md @@ -2,92 +2,92 @@ # HostConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] -**binds** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] -**containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] -**logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] -**networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] -**portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] -**restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] -**autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] -**volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] -**volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] -**mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] -**annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] -**capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] -**capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] -**cgroupnsMode** | [**inline**](#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. | [optional] -**dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] -**dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] -**dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] -**extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] -**groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] -**ipcMode** | **kotlin.String** | 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:<name|id>\"`: 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. | [optional] -**cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] -**links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] -**oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] -**pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] -**privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] -**publishAllPorts** | **kotlin.Boolean** | 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`. | [optional] -**readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] -**securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] -**storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] -**tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | 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\" } ``` | [optional] -**utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] -**usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] -**shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] -**sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [optional] -**runtime** | **kotlin.String** | Runtime to use with this container. | [optional] -**isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] -**maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] -**readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **binds** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] | +| **containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] | +| **logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] | +| **networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] | +| **portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | +| **autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] | +| **volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] | +| **volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] | +| **capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] | +| **capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] | +| **cgroupnsMode** | [**inline**](#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. | [optional] | +| **dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] | +| **dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] | +| **dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] | +| **extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] | +| **groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **ipcMode** | **kotlin.String** | 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:<name|id>\"`: 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. | [optional] | +| **cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] | +| **oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] | +| **pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] | +| **privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] | +| **publishAllPorts** | **kotlin.Boolean** | 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`. | [optional] | +| **readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] | +| **storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] | +| **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | 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\" } ``` | [optional] | +| **utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] | +| **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] | +| **shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [optional] | +| **runtime** | **kotlin.String** | Runtime to use with this container. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] | +| **maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] | +| **readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] | ## Enum: CgroupnsMode -Name | Value ----- | ----- -cgroupnsMode | private, host +| Name | Value | +| ---- | ----- | +| cgroupnsMode | private, host | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, process, hyperv +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv | diff --git a/api-model-v1-41/docs/HostConfigAllOfLogConfig.md b/api-model-v1-41/docs/HostConfigAllOfLogConfig.md index c267c287..9b4d0b20 100644 --- a/api-model-v1-41/docs/HostConfigAllOfLogConfig.md +++ b/api-model-v1-41/docs/HostConfigAllOfLogConfig.md @@ -2,17 +2,17 @@ # HostConfigAllOfLogConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | | [optional] -**config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | | [optional] | +| **config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none +| Name | Value | +| ---- | ----- | +| type | json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none | diff --git a/api-model-v1-41/docs/IPAM.md b/api-model-v1-41/docs/IPAM.md index a26095dd..0dcc133a 100644 --- a/api-model-v1-41/docs/IPAM.md +++ b/api-model-v1-41/docs/IPAM.md @@ -2,11 +2,11 @@ # IPAM ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] -**config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] | +| **config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] | diff --git a/api-model-v1-41/docs/IPAMConfig.md b/api-model-v1-41/docs/IPAMConfig.md index 23ac27ae..f667c688 100644 --- a/api-model-v1-41/docs/IPAMConfig.md +++ b/api-model-v1-41/docs/IPAMConfig.md @@ -2,12 +2,12 @@ # IPAMConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subnet** | **kotlin.String** | | [optional] -**ipRange** | **kotlin.String** | | [optional] -**gateway** | **kotlin.String** | | [optional] -**auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subnet** | **kotlin.String** | | [optional] | +| **ipRange** | **kotlin.String** | | [optional] | +| **gateway** | **kotlin.String** | | [optional] | +| **auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/IdResponse.md b/api-model-v1-41/docs/IdResponse.md index bd08f794..7f34c29a 100644 --- a/api-model-v1-41/docs/IdResponse.md +++ b/api-model-v1-41/docs/IdResponse.md @@ -2,9 +2,9 @@ # IdResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The id of the newly created object. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The id of the newly created object. | | diff --git a/api-model-v1-41/docs/ImageDeleteResponseItem.md b/api-model-v1-41/docs/ImageDeleteResponseItem.md index 55e813aa..a5ea281f 100644 --- a/api-model-v1-41/docs/ImageDeleteResponseItem.md +++ b/api-model-v1-41/docs/ImageDeleteResponseItem.md @@ -2,10 +2,10 @@ # ImageDeleteResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] -**deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] | +| **deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] | diff --git a/api-model-v1-41/docs/ImageID.md b/api-model-v1-41/docs/ImageID.md index a093f834..6717d92f 100644 --- a/api-model-v1-41/docs/ImageID.md +++ b/api-model-v1-41/docs/ImageID.md @@ -2,9 +2,9 @@ # ImageID ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/ImageInspect.md b/api-model-v1-41/docs/ImageInspect.md index bcaf6838..2d3860da 100644 --- a/api-model-v1-41/docs/ImageInspect.md +++ b/api-model-v1-41/docs/ImageInspect.md @@ -2,28 +2,28 @@ # ImageInspect ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] -**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] -**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] -**parent** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional] -**comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] -**created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**container** | **kotlin.String** | The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. | [optional] -**containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**dockerVersion** | **kotlin.String** | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional] -**author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] -**config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] -**variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] -**os** | **kotlin.String** | Operating System the image is built to run on. | [optional] -**osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] -**propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] -**virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] -**graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] -**rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] -**metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **parent** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional] | +| **comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] | +| **created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **container** | **kotlin.String** | The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. | [optional] | +| **containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **dockerVersion** | **kotlin.String** | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional] | +| **author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] | +| **variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] | +| **os** | **kotlin.String** | Operating System the image is built to run on. | [optional] | +| **osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] | +| **virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] | +| **rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] | +| **metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] | diff --git a/api-model-v1-41/docs/ImageInspectMetadata.md b/api-model-v1-41/docs/ImageInspectMetadata.md index eb610bd6..4a2386cd 100644 --- a/api-model-v1-41/docs/ImageInspectMetadata.md +++ b/api-model-v1-41/docs/ImageInspectMetadata.md @@ -2,9 +2,9 @@ # ImageInspectMetadata ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] | diff --git a/api-model-v1-41/docs/ImageInspectRootFS.md b/api-model-v1-41/docs/ImageInspectRootFS.md index 67b94d16..503e2a52 100644 --- a/api-model-v1-41/docs/ImageInspectRootFS.md +++ b/api-model-v1-41/docs/ImageInspectRootFS.md @@ -2,10 +2,10 @@ # ImageInspectRootFS ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | -**layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | +| **layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/ImagePruneResponse.md b/api-model-v1-41/docs/ImagePruneResponse.md index d041d483..79320b4a 100644 --- a/api-model-v1-41/docs/ImagePruneResponse.md +++ b/api-model-v1-41/docs/ImagePruneResponse.md @@ -2,10 +2,10 @@ # ImagePruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-41/docs/ImageSearchResponseItem.md b/api-model-v1-41/docs/ImageSearchResponseItem.md index 2ffed011..dd28db28 100644 --- a/api-model-v1-41/docs/ImageSearchResponseItem.md +++ b/api-model-v1-41/docs/ImageSearchResponseItem.md @@ -2,13 +2,13 @@ # ImageSearchResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **kotlin.String** | | [optional] -**official** | **kotlin.Boolean** | | [optional] -**automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always > be \"false\" in future. | [optional] -**name** | **kotlin.String** | | [optional] -**starCount** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | [optional] | +| **official** | **kotlin.Boolean** | | [optional] | +| **automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always > be \"false\" in future. | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **starCount** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/ImageSummary.md b/api-model-v1-41/docs/ImageSummary.md index 51573a1d..c26c83f9 100644 --- a/api-model-v1-41/docs/ImageSummary.md +++ b/api-model-v1-41/docs/ImageSummary.md @@ -2,18 +2,18 @@ # ImageSummary ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | -**parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | -**created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds sinds EPOCH). | -**propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | -**sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | -**containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. | -**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] -**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] -**virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | | +| **parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | | +| **created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds sinds EPOCH). | | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | | +| **sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | | +| **containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. | | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | diff --git a/api-model-v1-41/docs/IndexInfo.md b/api-model-v1-41/docs/IndexInfo.md index 7018edfd..6b714641 100644 --- a/api-model-v1-41/docs/IndexInfo.md +++ b/api-model-v1-41/docs/IndexInfo.md @@ -2,12 +2,12 @@ # IndexInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] -**mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] -**secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] -**official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] | +| **secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] | +| **official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] | diff --git a/api-model-v1-41/docs/JoinTokens.md b/api-model-v1-41/docs/JoinTokens.md index 3225a335..5055d1c0 100644 --- a/api-model-v1-41/docs/JoinTokens.md +++ b/api-model-v1-41/docs/JoinTokens.md @@ -2,10 +2,10 @@ # JoinTokens ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] -**manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] | +| **manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] | diff --git a/api-model-v1-41/docs/Limit.md b/api-model-v1-41/docs/Limit.md index 655aff6b..09c047eb 100644 --- a/api-model-v1-41/docs/Limit.md +++ b/api-model-v1-41/docs/Limit.md @@ -2,11 +2,11 @@ # Limit ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nanoCPUs** | **kotlin.Long** | | [optional] -**memoryBytes** | **kotlin.Long** | | [optional] -**pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] | diff --git a/api-model-v1-41/docs/ManagerStatus.md b/api-model-v1-41/docs/ManagerStatus.md index 93a37f68..bfaa004e 100644 --- a/api-model-v1-41/docs/ManagerStatus.md +++ b/api-model-v1-41/docs/ManagerStatus.md @@ -2,11 +2,11 @@ # ManagerStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**leader** | **kotlin.Boolean** | | [optional] -**reachability** | [**Reachability**](Reachability.md) | | [optional] -**addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **leader** | **kotlin.Boolean** | | [optional] | +| **reachability** | [**Reachability**](Reachability.md) | | [optional] | +| **addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] | diff --git a/api-model-v1-41/docs/Mount.md b/api-model-v1-41/docs/Mount.md index 1045b64a..53eaf65c 100644 --- a/api-model-v1-41/docs/Mount.md +++ b/api-model-v1-41/docs/Mount.md @@ -2,23 +2,23 @@ # Mount ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target** | **kotlin.String** | Container path. | [optional] -**source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] -**type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] -**readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] -**consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] -**bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] -**volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] -**tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | Container path. | [optional] | +| **source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] | +| **type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] | +| **readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] | +| **consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] | +| **bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] | +| **volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] | +| **tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | bind, volume, tmpfs, npipe, cluster +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | diff --git a/api-model-v1-41/docs/MountBindOptions.md b/api-model-v1-41/docs/MountBindOptions.md index 098ceacf..76767037 100644 --- a/api-model-v1-41/docs/MountBindOptions.md +++ b/api-model-v1-41/docs/MountBindOptions.md @@ -2,17 +2,17 @@ # MountBindOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] -**nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] | +| **nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] | ## Enum: Propagation -Name | Value ----- | ----- -propagation | private, rprivate, shared, rshared, slave, rslave +| Name | Value | +| ---- | ----- | +| propagation | private, rprivate, shared, rshared, slave, rslave | diff --git a/api-model-v1-41/docs/MountPoint.md b/api-model-v1-41/docs/MountPoint.md index f1a52839..58fe87ce 100644 --- a/api-model-v1-41/docs/MountPoint.md +++ b/api-model-v1-41/docs/MountPoint.md @@ -2,23 +2,23 @@ # MountPoint ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] -**name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] -**source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] -**destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] -**driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] -**mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] -**RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] -**propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] | +| **name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] | +| **source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] | +| **destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] | +| **driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] | +| **mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] | +| **RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] | +| **propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | bind, volume, tmpfs, npipe, cluster +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | diff --git a/api-model-v1-41/docs/MountTmpfsOptions.md b/api-model-v1-41/docs/MountTmpfsOptions.md index 94a17779..47a839a1 100644 --- a/api-model-v1-41/docs/MountTmpfsOptions.md +++ b/api-model-v1-41/docs/MountTmpfsOptions.md @@ -2,10 +2,10 @@ # MountTmpfsOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] -**mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] | +| **mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] | diff --git a/api-model-v1-41/docs/MountVolumeOptions.md b/api-model-v1-41/docs/MountVolumeOptions.md index 2fdfdecf..cf000f7f 100644 --- a/api-model-v1-41/docs/MountVolumeOptions.md +++ b/api-model-v1-41/docs/MountVolumeOptions.md @@ -2,11 +2,11 @@ # MountVolumeOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] | diff --git a/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md b/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md index 084ee2c5..3cb98230 100644 --- a/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md +++ b/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md @@ -2,10 +2,10 @@ # MountVolumeOptionsDriverConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] | diff --git a/api-model-v1-41/docs/Network.md b/api-model-v1-41/docs/Network.md index 1af62551..f72eea2b 100644 --- a/api-model-v1-41/docs/Network.md +++ b/api-model-v1-41/docs/Network.md @@ -2,21 +2,21 @@ # Network ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**id** | **kotlin.String** | | [optional] -**created** | **kotlin.String** | | [optional] -**scope** | **kotlin.String** | | [optional] -**driver** | **kotlin.String** | | [optional] -**enableIPv6** | **kotlin.Boolean** | | [optional] -**IPAM** | [**IPAM**](IPAM.md) | | [optional] -**`internal`** | **kotlin.Boolean** | | [optional] -**attachable** | **kotlin.Boolean** | | [optional] -**ingress** | **kotlin.Boolean** | | [optional] -**containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **id** | **kotlin.String** | | [optional] | +| **created** | **kotlin.String** | | [optional] | +| **scope** | **kotlin.String** | | [optional] | +| **driver** | **kotlin.String** | | [optional] | +| **enableIPv6** | **kotlin.Boolean** | | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | | [optional] | +| **attachable** | **kotlin.Boolean** | | [optional] | +| **ingress** | **kotlin.Boolean** | | [optional] | +| **containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/NetworkAttachmentConfig.md b/api-model-v1-41/docs/NetworkAttachmentConfig.md index 55eae4cb..3f9c3cc4 100644 --- a/api-model-v1-41/docs/NetworkAttachmentConfig.md +++ b/api-model-v1-41/docs/NetworkAttachmentConfig.md @@ -2,11 +2,11 @@ # NetworkAttachmentConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] -**aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] | diff --git a/api-model-v1-41/docs/NetworkConnectRequest.md b/api-model-v1-41/docs/NetworkConnectRequest.md index 04789a8b..ae2c9438 100644 --- a/api-model-v1-41/docs/NetworkConnectRequest.md +++ b/api-model-v1-41/docs/NetworkConnectRequest.md @@ -2,10 +2,10 @@ # NetworkConnectRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**container** | **kotlin.String** | The ID or name of the container to connect to the network. | [optional] -**endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **container** | **kotlin.String** | The ID or name of the container to connect to the network. | [optional] | +| **endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] | diff --git a/api-model-v1-41/docs/NetworkContainer.md b/api-model-v1-41/docs/NetworkContainer.md index cc9e9482..5da790f2 100644 --- a/api-model-v1-41/docs/NetworkContainer.md +++ b/api-model-v1-41/docs/NetworkContainer.md @@ -2,13 +2,13 @@ # NetworkContainer ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**endpointID** | **kotlin.String** | | [optional] -**macAddress** | **kotlin.String** | | [optional] -**ipv4Address** | **kotlin.String** | | [optional] -**ipv6Address** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **endpointID** | **kotlin.String** | | [optional] | +| **macAddress** | **kotlin.String** | | [optional] | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/NetworkCreateRequest.md b/api-model-v1-41/docs/NetworkCreateRequest.md index 9a43a103..a8c1b1c5 100644 --- a/api-model-v1-41/docs/NetworkCreateRequest.md +++ b/api-model-v1-41/docs/NetworkCreateRequest.md @@ -2,18 +2,18 @@ # NetworkCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The network's name. | -**checkDuplicate** | **kotlin.Boolean** | Deprecated: CheckDuplicate is now always enabled. | [optional] -**driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] -**`internal`** | **kotlin.Boolean** | Restrict external access to the network. | [optional] -**attachable** | **kotlin.Boolean** | Globally scoped network is manually attachable by regular containers from workers in swarm mode. | [optional] -**ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] -**IPAM** | [**IPAM**](IPAM.md) | | [optional] -**enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The network's name. | | +| **checkDuplicate** | **kotlin.Boolean** | Deprecated: CheckDuplicate is now always enabled. | [optional] | +| **driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] | +| **`internal`** | **kotlin.Boolean** | Restrict external access to the network. | [optional] | +| **attachable** | **kotlin.Boolean** | Globally scoped network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | diff --git a/api-model-v1-41/docs/NetworkCreateResponse.md b/api-model-v1-41/docs/NetworkCreateResponse.md index 4535ebc4..319cddb2 100644 --- a/api-model-v1-41/docs/NetworkCreateResponse.md +++ b/api-model-v1-41/docs/NetworkCreateResponse.md @@ -2,10 +2,10 @@ # NetworkCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the created network. | [optional] -**warning** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created network. | [optional] | +| **warning** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/NetworkDisconnectRequest.md b/api-model-v1-41/docs/NetworkDisconnectRequest.md index 5adfb121..c5d297fd 100644 --- a/api-model-v1-41/docs/NetworkDisconnectRequest.md +++ b/api-model-v1-41/docs/NetworkDisconnectRequest.md @@ -2,10 +2,10 @@ # NetworkDisconnectRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**container** | **kotlin.String** | The ID or name of the container to disconnect from the network. | [optional] -**force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **container** | **kotlin.String** | The ID or name of the container to disconnect from the network. | [optional] | +| **force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] | diff --git a/api-model-v1-41/docs/NetworkPruneResponse.md b/api-model-v1-41/docs/NetworkPruneResponse.md index 3f4d1a9c..9458d15f 100644 --- a/api-model-v1-41/docs/NetworkPruneResponse.md +++ b/api-model-v1-41/docs/NetworkPruneResponse.md @@ -2,9 +2,9 @@ # NetworkPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] | diff --git a/api-model-v1-41/docs/NetworkSettings.md b/api-model-v1-41/docs/NetworkSettings.md index f8df75d6..aab20b01 100644 --- a/api-model-v1-41/docs/NetworkSettings.md +++ b/api-model-v1-41/docs/NetworkSettings.md @@ -2,26 +2,26 @@ # NetworkSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bridge** | **kotlin.String** | Name of the network's bridge (for example, `docker0`). | [optional] -**sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] -**hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. | [optional] -**linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. | [optional] -**linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. | [optional] -**ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] -**sandboxKey** | **kotlin.String** | SandboxKey identifies the sandbox | [optional] -**secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [optional] -**secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [optional] -**endpointID** | **kotlin.String** | EndpointID uniquely represents a service endpoint in a Sandbox. <p><br /></p> > **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 | [optional] -**gateway** | **kotlin.String** | Gateway address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**globalIPv6Address** | **kotlin.String** | Global IPv6 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**globalIPv6PrefixLen** | **kotlin.Int** | Mask length of the global IPv6 address. <p><br /></p> > **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 | [optional] -**ipAddress** | **kotlin.String** | IPv4 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. <p><br /></p> > **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 | [optional] -**ipv6Gateway** | **kotlin.String** | IPv6 gateway address for this network. <p><br /></p> > **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 | [optional] -**macAddress** | **kotlin.String** | MAC address for the container on the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **bridge** | **kotlin.String** | Name of the network's bridge (for example, `docker0`). | [optional] | +| **sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] | +| **hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. | [optional] | +| **linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. | [optional] | +| **linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. | [optional] | +| **ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **sandboxKey** | **kotlin.String** | SandboxKey identifies the sandbox | [optional] | +| **secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [optional] | +| **secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [optional] | +| **endpointID** | **kotlin.String** | EndpointID uniquely represents a service endpoint in a Sandbox. <p><br /></p> > **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 | [optional] | +| **gateway** | **kotlin.String** | Gateway address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Int** | Mask length of the global IPv6 address. <p><br /></p> > **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 | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. <p><br /></p> > **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 | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address for this network. <p><br /></p> > **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 | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the container on the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] | diff --git a/api-model-v1-41/docs/NetworkingConfig.md b/api-model-v1-41/docs/NetworkingConfig.md index a6869a77..72814533 100644 --- a/api-model-v1-41/docs/NetworkingConfig.md +++ b/api-model-v1-41/docs/NetworkingConfig.md @@ -2,9 +2,9 @@ # NetworkingConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] | diff --git a/api-model-v1-41/docs/Node.md b/api-model-v1-41/docs/Node.md index b66079d4..8c180d58 100644 --- a/api-model-v1-41/docs/Node.md +++ b/api-model-v1-41/docs/Node.md @@ -2,16 +2,16 @@ # Node ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**NodeSpec**](NodeSpec.md) | | [optional] -**description** | [**NodeDescription**](NodeDescription.md) | | [optional] -**status** | [**NodeStatus**](NodeStatus.md) | | [optional] -**managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**NodeSpec**](NodeSpec.md) | | [optional] | +| **description** | [**NodeDescription**](NodeDescription.md) | | [optional] | +| **status** | [**NodeStatus**](NodeStatus.md) | | [optional] | +| **managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] | diff --git a/api-model-v1-41/docs/NodeDescription.md b/api-model-v1-41/docs/NodeDescription.md index 4a5dc851..9f9e1538 100644 --- a/api-model-v1-41/docs/NodeDescription.md +++ b/api-model-v1-41/docs/NodeDescription.md @@ -2,13 +2,13 @@ # NodeDescription ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | | [optional] -**platform** | [**Platform**](Platform.md) | | [optional] -**resources** | [**ResourceObject**](ResourceObject.md) | | [optional] -**engine** | [**EngineDescription**](EngineDescription.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | | [optional] | +| **platform** | [**Platform**](Platform.md) | | [optional] | +| **resources** | [**ResourceObject**](ResourceObject.md) | | [optional] | +| **engine** | [**EngineDescription**](EngineDescription.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | diff --git a/api-model-v1-41/docs/NodeSpec.md b/api-model-v1-41/docs/NodeSpec.md index 20f108e2..c4bf3121 100644 --- a/api-model-v1-41/docs/NodeSpec.md +++ b/api-model-v1-41/docs/NodeSpec.md @@ -2,26 +2,26 @@ # NodeSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name for the node. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**role** | [**inline**](#Role) | Role of the node. | [optional] -**availability** | [**inline**](#Availability) | Availability of the node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name for the node. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **role** | [**inline**](#Role) | Role of the node. | [optional] | +| **availability** | [**inline**](#Availability) | Availability of the node. | [optional] | ## Enum: Role -Name | Value ----- | ----- -role | worker, manager +| Name | Value | +| ---- | ----- | +| role | worker, manager | ## Enum: Availability -Name | Value ----- | ----- -availability | active, pause, drain +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | diff --git a/api-model-v1-41/docs/NodeStatus.md b/api-model-v1-41/docs/NodeStatus.md index 86eaa2d9..426c3f2d 100644 --- a/api-model-v1-41/docs/NodeStatus.md +++ b/api-model-v1-41/docs/NodeStatus.md @@ -2,11 +2,11 @@ # NodeStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**state** | [**NodeState**](NodeState.md) | | [optional] -**message** | **kotlin.String** | | [optional] -**addr** | **kotlin.String** | IP address of the node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**NodeState**](NodeState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | IP address of the node. | [optional] | diff --git a/api-model-v1-41/docs/OCIDescriptor.md b/api-model-v1-41/docs/OCIDescriptor.md index f31d04e6..76474758 100644 --- a/api-model-v1-41/docs/OCIDescriptor.md +++ b/api-model-v1-41/docs/OCIDescriptor.md @@ -2,11 +2,11 @@ # OCIDescriptor ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] -**digest** | **kotlin.String** | The digest of the targeted content. | [optional] -**propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] | +| **digest** | **kotlin.String** | The digest of the targeted content. | [optional] | +| **propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] | diff --git a/api-model-v1-41/docs/OCIPlatform.md b/api-model-v1-41/docs/OCIPlatform.md index 76d3ec98..606c4124 100644 --- a/api-model-v1-41/docs/OCIPlatform.md +++ b/api-model-v1-41/docs/OCIPlatform.md @@ -2,13 +2,13 @@ # OCIPlatform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] -**os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] -**osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] -**osFeatures** | **kotlin.collections.MutableList<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] -**variant** | **kotlin.String** | Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] | +| **os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] | +| **osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] | +| **osFeatures** | **kotlin.collections.MutableList<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] | +| **variant** | **kotlin.String** | Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. | [optional] | diff --git a/api-model-v1-41/docs/ObjectVersion.md b/api-model-v1-41/docs/ObjectVersion.md index 63306ac0..a2584d76 100644 --- a/api-model-v1-41/docs/ObjectVersion.md +++ b/api-model-v1-41/docs/ObjectVersion.md @@ -2,9 +2,9 @@ # ObjectVersion ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **index** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/PeerNode.md b/api-model-v1-41/docs/PeerNode.md index 986599f9..e3954b83 100644 --- a/api-model-v1-41/docs/PeerNode.md +++ b/api-model-v1-41/docs/PeerNode.md @@ -2,10 +2,10 @@ # PeerNode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] -**addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] | diff --git a/api-model-v1-41/docs/Platform.md b/api-model-v1-41/docs/Platform.md index 7a876750..d8a705d2 100644 --- a/api-model-v1-41/docs/Platform.md +++ b/api-model-v1-41/docs/Platform.md @@ -2,10 +2,10 @@ # Platform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] -**OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] | +| **OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] | diff --git a/api-model-v1-41/docs/Plugin.md b/api-model-v1-41/docs/Plugin.md index 761860d1..cd67ed8a 100644 --- a/api-model-v1-41/docs/Plugin.md +++ b/api-model-v1-41/docs/Plugin.md @@ -2,14 +2,14 @@ # Plugin ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | -**settings** | [**PluginSettings**](PluginSettings.md) | | -**config** | [**PluginConfig**](PluginConfig.md) | | -**id** | **kotlin.String** | | [optional] -**pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | | +| **settings** | [**PluginSettings**](PluginSettings.md) | | | +| **config** | [**PluginConfig**](PluginConfig.md) | | | +| **id** | **kotlin.String** | | [optional] | +| **pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] | diff --git a/api-model-v1-41/docs/PluginConfig.md b/api-model-v1-41/docs/PluginConfig.md index b1c55fba..064225fb 100644 --- a/api-model-v1-41/docs/PluginConfig.md +++ b/api-model-v1-41/docs/PluginConfig.md @@ -2,24 +2,24 @@ # PluginConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **kotlin.String** | | -**documentation** | **kotlin.String** | | -**`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | -**workDir** | **kotlin.String** | | -**network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | -**linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | -**propagatedMount** | **kotlin.String** | | -**ipcHost** | **kotlin.Boolean** | | -**pidHost** | **kotlin.Boolean** | | -**mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | -**env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | -**args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | -**dockerVersion** | **kotlin.String** | Docker Version used to create the plugin | [optional] -**user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] -**rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | | +| **documentation** | **kotlin.String** | | | +| **`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **workDir** | **kotlin.String** | | | +| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | | +| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | | +| **propagatedMount** | **kotlin.String** | | | +| **ipcHost** | **kotlin.Boolean** | | | +| **pidHost** | **kotlin.Boolean** | | | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | | +| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | | +| **dockerVersion** | **kotlin.String** | Docker Version used to create the plugin | [optional] | +| **user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] | +| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] | diff --git a/api-model-v1-41/docs/PluginConfigArgs.md b/api-model-v1-41/docs/PluginConfigArgs.md index d1c4ec86..77ce533c 100644 --- a/api-model-v1-41/docs/PluginConfigArgs.md +++ b/api-model-v1-41/docs/PluginConfigArgs.md @@ -2,12 +2,12 @@ # PluginConfigArgs ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | | diff --git a/api-model-v1-41/docs/PluginConfigInterface.md b/api-model-v1-41/docs/PluginConfigInterface.md index d9fad568..2c930f60 100644 --- a/api-model-v1-41/docs/PluginConfigInterface.md +++ b/api-model-v1-41/docs/PluginConfigInterface.md @@ -2,18 +2,18 @@ # PluginConfigInterface ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | -**socket** | **kotlin.String** | | -**protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | | +| **socket** | **kotlin.String** | | | +| **protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] | ## Enum: ProtocolScheme -Name | Value ----- | ----- -protocolScheme | , moby.plugins.http/v1 +| Name | Value | +| ---- | ----- | +| protocolScheme | , moby.plugins.http/v1 | diff --git a/api-model-v1-41/docs/PluginConfigLinux.md b/api-model-v1-41/docs/PluginConfigLinux.md index a343e2ad..f3ca6ce8 100644 --- a/api-model-v1-41/docs/PluginConfigLinux.md +++ b/api-model-v1-41/docs/PluginConfigLinux.md @@ -2,11 +2,11 @@ # PluginConfigLinux ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | -**allowAllDevices** | **kotlin.Boolean** | | -**devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **allowAllDevices** | **kotlin.Boolean** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | diff --git a/api-model-v1-41/docs/PluginConfigNetwork.md b/api-model-v1-41/docs/PluginConfigNetwork.md index dae618b3..4b0e40e5 100644 --- a/api-model-v1-41/docs/PluginConfigNetwork.md +++ b/api-model-v1-41/docs/PluginConfigNetwork.md @@ -2,9 +2,9 @@ # PluginConfigNetwork ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/PluginConfigRootfs.md b/api-model-v1-41/docs/PluginConfigRootfs.md index b216d3e8..4f17530b 100644 --- a/api-model-v1-41/docs/PluginConfigRootfs.md +++ b/api-model-v1-41/docs/PluginConfigRootfs.md @@ -2,10 +2,10 @@ # PluginConfigRootfs ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | [optional] -**diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/PluginConfigUser.md b/api-model-v1-41/docs/PluginConfigUser.md index 81aa9259..1d3973c2 100644 --- a/api-model-v1-41/docs/PluginConfigUser.md +++ b/api-model-v1-41/docs/PluginConfigUser.md @@ -2,10 +2,10 @@ # PluginConfigUser ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UID** | **kotlin.Int** | | [optional] -**GID** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **UID** | **kotlin.Int** | | [optional] | +| **GID** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/PluginDevice.md b/api-model-v1-41/docs/PluginDevice.md index 55c5bc33..9ca354a5 100644 --- a/api-model-v1-41/docs/PluginDevice.md +++ b/api-model-v1-41/docs/PluginDevice.md @@ -2,12 +2,12 @@ # PluginDevice ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**path** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **path** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/PluginEnv.md b/api-model-v1-41/docs/PluginEnv.md index 49ccca71..ff31d08b 100644 --- a/api-model-v1-41/docs/PluginEnv.md +++ b/api-model-v1-41/docs/PluginEnv.md @@ -2,12 +2,12 @@ # PluginEnv ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**`value`** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/PluginInterfaceType.md b/api-model-v1-41/docs/PluginInterfaceType.md index c0eb9f5c..de46fee9 100644 --- a/api-model-v1-41/docs/PluginInterfaceType.md +++ b/api-model-v1-41/docs/PluginInterfaceType.md @@ -2,11 +2,11 @@ # PluginInterfaceType ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**prefix** | **kotlin.String** | | -**capability** | **kotlin.String** | | -**version** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **prefix** | **kotlin.String** | | | +| **capability** | **kotlin.String** | | | +| **version** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/PluginMount.md b/api-model-v1-41/docs/PluginMount.md index c6dff2af..77eaf741 100644 --- a/api-model-v1-41/docs/PluginMount.md +++ b/api-model-v1-41/docs/PluginMount.md @@ -2,15 +2,15 @@ # PluginMount ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**source** | **kotlin.String** | | -**destination** | **kotlin.String** | | -**type** | **kotlin.String** | | -**options** | **kotlin.collections.MutableList<kotlin.String>** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **source** | **kotlin.String** | | | +| **destination** | **kotlin.String** | | | +| **type** | **kotlin.String** | | | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | | | diff --git a/api-model-v1-41/docs/PluginPrivilege.md b/api-model-v1-41/docs/PluginPrivilege.md index 4e580989..5c384bb6 100644 --- a/api-model-v1-41/docs/PluginPrivilege.md +++ b/api-model-v1-41/docs/PluginPrivilege.md @@ -2,11 +2,11 @@ # PluginPrivilege ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**description** | **kotlin.String** | | [optional] -**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **description** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/PluginSettings.md b/api-model-v1-41/docs/PluginSettings.md index 8d1985c2..1797e9c5 100644 --- a/api-model-v1-41/docs/PluginSettings.md +++ b/api-model-v1-41/docs/PluginSettings.md @@ -2,12 +2,12 @@ # PluginSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | -**env** | **kotlin.collections.MutableList<kotlin.String>** | | -**args** | **kotlin.collections.MutableList<kotlin.String>** | | -**devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | diff --git a/api-model-v1-41/docs/PluginsInfo.md b/api-model-v1-41/docs/PluginsInfo.md index 233e9342..6f726d26 100644 --- a/api-model-v1-41/docs/PluginsInfo.md +++ b/api-model-v1-41/docs/PluginsInfo.md @@ -2,12 +2,12 @@ # PluginsInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] -**network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] -**authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] -**log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] | +| **network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] | +| **authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] | +| **log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] | diff --git a/api-model-v1-41/docs/Port.md b/api-model-v1-41/docs/Port.md index bfc09156..5f73834c 100644 --- a/api-model-v1-41/docs/Port.md +++ b/api-model-v1-41/docs/Port.md @@ -2,19 +2,19 @@ # Port ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**privatePort** | **kotlin.Int** | Port on the container | -**type** | [**inline**](#Type) | | -**IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] -**publicPort** | **kotlin.Int** | Port exposed on the host | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privatePort** | **kotlin.Int** | Port on the container | | +| **type** | [**inline**](#Type) | | | +| **IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] | +| **publicPort** | **kotlin.Int** | Port exposed on the host | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | tcp, udp, sctp +| Name | Value | +| ---- | ----- | +| type | tcp, udp, sctp | diff --git a/api-model-v1-41/docs/PortBinding.md b/api-model-v1-41/docs/PortBinding.md index 3a0978f1..0cf0dea5 100644 --- a/api-model-v1-41/docs/PortBinding.md +++ b/api-model-v1-41/docs/PortBinding.md @@ -2,10 +2,10 @@ # PortBinding ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] -**hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] | +| **hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] | diff --git a/api-model-v1-41/docs/PortStatus.md b/api-model-v1-41/docs/PortStatus.md index cbdeedc0..24def5e3 100644 --- a/api-model-v1-41/docs/PortStatus.md +++ b/api-model-v1-41/docs/PortStatus.md @@ -2,9 +2,9 @@ # PortStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | diff --git a/api-model-v1-41/docs/ProcessConfig.md b/api-model-v1-41/docs/ProcessConfig.md index 5ad4c154..921ea328 100644 --- a/api-model-v1-41/docs/ProcessConfig.md +++ b/api-model-v1-41/docs/ProcessConfig.md @@ -2,13 +2,13 @@ # ProcessConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**privileged** | **kotlin.Boolean** | | [optional] -**user** | **kotlin.String** | | [optional] -**tty** | **kotlin.Boolean** | | [optional] -**entrypoint** | **kotlin.String** | | [optional] -**arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privileged** | **kotlin.Boolean** | | [optional] | +| **user** | **kotlin.String** | | [optional] | +| **tty** | **kotlin.Boolean** | | [optional] | +| **entrypoint** | **kotlin.String** | | [optional] | +| **arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/ProgressDetail.md b/api-model-v1-41/docs/ProgressDetail.md index c70ad3b3..17d327a3 100644 --- a/api-model-v1-41/docs/ProgressDetail.md +++ b/api-model-v1-41/docs/ProgressDetail.md @@ -2,10 +2,10 @@ # ProgressDetail ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**current** | **kotlin.Int** | | [optional] -**total** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **current** | **kotlin.Int** | | [optional] | +| **total** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/PushImageInfo.md b/api-model-v1-41/docs/PushImageInfo.md index 5eddb6c0..35a5e13f 100644 --- a/api-model-v1-41/docs/PushImageInfo.md +++ b/api-model-v1-41/docs/PushImageInfo.md @@ -2,12 +2,12 @@ # PushImageInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **kotlin.String** | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **error** | **kotlin.String** | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | diff --git a/api-model-v1-41/docs/RegistryServiceConfig.md b/api-model-v1-41/docs/RegistryServiceConfig.md index 052a1274..8359fbc9 100644 --- a/api-model-v1-41/docs/RegistryServiceConfig.md +++ b/api-model-v1-41/docs/RegistryServiceConfig.md @@ -2,13 +2,13 @@ # RegistryServiceConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allowNondistributableArtifactsCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**allowNondistributableArtifactsHostnames** | **kotlin.collections.MutableList<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] -**indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] -**mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **allowNondistributableArtifactsCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] | +| **allowNondistributableArtifactsHostnames** | **kotlin.collections.MutableList<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] | +| **insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] | +| **indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] | diff --git a/api-model-v1-41/docs/ResourceObject.md b/api-model-v1-41/docs/ResourceObject.md index 044d53a5..b4652bf8 100644 --- a/api-model-v1-41/docs/ResourceObject.md +++ b/api-model-v1-41/docs/ResourceObject.md @@ -2,11 +2,11 @@ # ResourceObject ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nanoCPUs** | **kotlin.Long** | | [optional] -**memoryBytes** | **kotlin.Long** | | [optional] -**genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | diff --git a/api-model-v1-41/docs/Resources.md b/api-model-v1-41/docs/Resources.md index f83e46c8..f18a199b 100644 --- a/api-model-v1-41/docs/Resources.md +++ b/api-model-v1-41/docs/Resources.md @@ -2,39 +2,39 @@ # Resources ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | diff --git a/api-model-v1-41/docs/ResourcesBlkioWeightDeviceInner.md b/api-model-v1-41/docs/ResourcesBlkioWeightDeviceInner.md index 2160bf09..8adad1d4 100644 --- a/api-model-v1-41/docs/ResourcesBlkioWeightDeviceInner.md +++ b/api-model-v1-41/docs/ResourcesBlkioWeightDeviceInner.md @@ -2,10 +2,10 @@ # ResourcesBlkioWeightDeviceInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | | [optional] -**weight** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | | [optional] | +| **weight** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-41/docs/ResourcesUlimitsInner.md b/api-model-v1-41/docs/ResourcesUlimitsInner.md index 312c7956..8ad484f1 100644 --- a/api-model-v1-41/docs/ResourcesUlimitsInner.md +++ b/api-model-v1-41/docs/ResourcesUlimitsInner.md @@ -2,11 +2,11 @@ # ResourcesUlimitsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of ulimit | [optional] -**soft** | **kotlin.Int** | Soft limit | [optional] -**hard** | **kotlin.Int** | Hard limit | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of ulimit | [optional] | +| **soft** | **kotlin.Int** | Soft limit | [optional] | +| **hard** | **kotlin.Int** | Hard limit | [optional] | diff --git a/api-model-v1-41/docs/RestartPolicy.md b/api-model-v1-41/docs/RestartPolicy.md index cea00dc6..09a0e982 100644 --- a/api-model-v1-41/docs/RestartPolicy.md +++ b/api-model-v1-41/docs/RestartPolicy.md @@ -2,17 +2,17 @@ # RestartPolicy ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**inline**](#Name) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] -**maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | [**inline**](#Name) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] | +| **maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] | ## Enum: Name -Name | Value ----- | ----- -name | , no, always, unless-stopped, on-failure +| Name | Value | +| ---- | ----- | +| name | , no, always, unless-stopped, on-failure | diff --git a/api-model-v1-41/docs/Runtime.md b/api-model-v1-41/docs/Runtime.md index 2d06eca7..35426fa0 100644 --- a/api-model-v1-41/docs/Runtime.md +++ b/api-model-v1-41/docs/Runtime.md @@ -2,10 +2,10 @@ # Runtime ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] -**runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] | diff --git a/api-model-v1-41/docs/Secret.md b/api-model-v1-41/docs/Secret.md index 645fc011..9a87a568 100644 --- a/api-model-v1-41/docs/Secret.md +++ b/api-model-v1-41/docs/Secret.md @@ -2,13 +2,13 @@ # Secret ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**SecretSpec**](SecretSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**SecretSpec**](SecretSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/SecretCreateRequest.md b/api-model-v1-41/docs/SecretCreateRequest.md index 97257bdb..b445a37f 100644 --- a/api-model-v1-41/docs/SecretCreateRequest.md +++ b/api-model-v1-41/docs/SecretCreateRequest.md @@ -2,13 +2,13 @@ # SecretCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the secret. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] -**driver** | [**Driver**](Driver.md) | | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-41/docs/SecretSpec.md b/api-model-v1-41/docs/SecretSpec.md index 38118de3..539c6aad 100644 --- a/api-model-v1-41/docs/SecretSpec.md +++ b/api-model-v1-41/docs/SecretSpec.md @@ -2,13 +2,13 @@ # SecretSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the secret. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] -**driver** | [**Driver**](Driver.md) | | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-41/docs/Service.md b/api-model-v1-41/docs/Service.md index c49a4aeb..d2e0c3c9 100644 --- a/api-model-v1-41/docs/Service.md +++ b/api-model-v1-41/docs/Service.md @@ -2,17 +2,17 @@ # Service ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] -**endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] -**updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] -**serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] -**jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] | +| **endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] | +| **updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] | +| **serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] | +| **jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] | diff --git a/api-model-v1-41/docs/ServiceCreateRequest.md b/api-model-v1-41/docs/ServiceCreateRequest.md index 77f993f8..e13b9730 100644 --- a/api-model-v1-41/docs/ServiceCreateRequest.md +++ b/api-model-v1-41/docs/ServiceCreateRequest.md @@ -2,16 +2,16 @@ # ServiceCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/ServiceCreateResponse.md b/api-model-v1-41/docs/ServiceCreateResponse.md index 1b18c827..efa52938 100644 --- a/api-model-v1-41/docs/ServiceCreateResponse.md +++ b/api-model-v1-41/docs/ServiceCreateResponse.md @@ -2,11 +2,11 @@ # ServiceCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the created service. | [optional] -**warning** | **kotlin.String** | Optional warning message. deprecated: this is only kept for backwards compatibility and will be removed. | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the created service. | [optional] | +| **warning** | **kotlin.String** | Optional warning message. deprecated: this is only kept for backwards compatibility and will be removed. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] | diff --git a/api-model-v1-41/docs/ServiceEndpoint.md b/api-model-v1-41/docs/ServiceEndpoint.md index b3e08c5d..e0f1c900 100644 --- a/api-model-v1-41/docs/ServiceEndpoint.md +++ b/api-model-v1-41/docs/ServiceEndpoint.md @@ -2,11 +2,11 @@ # ServiceEndpoint ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] -**virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | +| **virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] | diff --git a/api-model-v1-41/docs/ServiceEndpointVirtualIPsInner.md b/api-model-v1-41/docs/ServiceEndpointVirtualIPsInner.md index 52b7db86..f893c9c6 100644 --- a/api-model-v1-41/docs/ServiceEndpointVirtualIPsInner.md +++ b/api-model-v1-41/docs/ServiceEndpointVirtualIPsInner.md @@ -2,10 +2,10 @@ # ServiceEndpointVirtualIPsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networkID** | **kotlin.String** | | [optional] -**addr** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkID** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-41/docs/ServiceJobStatus.md b/api-model-v1-41/docs/ServiceJobStatus.md index 8ba99c0c..8227bff6 100644 --- a/api-model-v1-41/docs/ServiceJobStatus.md +++ b/api-model-v1-41/docs/ServiceJobStatus.md @@ -2,10 +2,10 @@ # ServiceJobStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] | diff --git a/api-model-v1-41/docs/ServiceServiceStatus.md b/api-model-v1-41/docs/ServiceServiceStatus.md index 5d1df316..79fd1de2 100644 --- a/api-model-v1-41/docs/ServiceServiceStatus.md +++ b/api-model-v1-41/docs/ServiceServiceStatus.md @@ -2,11 +2,11 @@ # ServiceServiceStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] -**desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] -**completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] | +| **desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] | +| **completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] | diff --git a/api-model-v1-41/docs/ServiceSpec.md b/api-model-v1-41/docs/ServiceSpec.md index 3fdae731..2c5c547c 100644 --- a/api-model-v1-41/docs/ServiceSpec.md +++ b/api-model-v1-41/docs/ServiceSpec.md @@ -2,16 +2,16 @@ # ServiceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/ServiceSpecMode.md b/api-model-v1-41/docs/ServiceSpecMode.md index c74a2c35..7b9ddebd 100644 --- a/api-model-v1-41/docs/ServiceSpecMode.md +++ b/api-model-v1-41/docs/ServiceSpecMode.md @@ -2,12 +2,12 @@ # ServiceSpecMode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] -**global** | [**kotlin.Any**](.md) | | [optional] -**replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] -**globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] | +| **global** | [**kotlin.Any**](.md) | | [optional] | +| **replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] | +| **globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] | diff --git a/api-model-v1-41/docs/ServiceSpecModeReplicated.md b/api-model-v1-41/docs/ServiceSpecModeReplicated.md index 721d67d6..9e2617c0 100644 --- a/api-model-v1-41/docs/ServiceSpecModeReplicated.md +++ b/api-model-v1-41/docs/ServiceSpecModeReplicated.md @@ -2,9 +2,9 @@ # ServiceSpecModeReplicated ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**replicas** | **kotlin.Long** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicas** | **kotlin.Long** | | [optional] | diff --git a/api-model-v1-41/docs/ServiceSpecModeReplicatedJob.md b/api-model-v1-41/docs/ServiceSpecModeReplicatedJob.md index 64cd1877..215cf92f 100644 --- a/api-model-v1-41/docs/ServiceSpecModeReplicatedJob.md +++ b/api-model-v1-41/docs/ServiceSpecModeReplicatedJob.md @@ -2,10 +2,10 @@ # ServiceSpecModeReplicatedJob ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] -**totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] | +| **totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] | diff --git a/api-model-v1-41/docs/ServiceSpecRollbackConfig.md b/api-model-v1-41/docs/ServiceSpecRollbackConfig.md index 4858c8ac..109ce61a 100644 --- a/api-model-v1-41/docs/ServiceSpecRollbackConfig.md +++ b/api-model-v1-41/docs/ServiceSpecRollbackConfig.md @@ -2,28 +2,28 @@ # ServiceSpecRollbackConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] -**delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] -**failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] -**monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] -**maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] -**order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | ## Enum: FailureAction -Name | Value ----- | ----- -failureAction | continue, pause +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause | ## Enum: Order -Name | Value ----- | ----- -order | stop-first, start-first +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | diff --git a/api-model-v1-41/docs/ServiceSpecUpdateConfig.md b/api-model-v1-41/docs/ServiceSpecUpdateConfig.md index 9a45b366..b8a267a7 100644 --- a/api-model-v1-41/docs/ServiceSpecUpdateConfig.md +++ b/api-model-v1-41/docs/ServiceSpecUpdateConfig.md @@ -2,28 +2,28 @@ # ServiceSpecUpdateConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] -**delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] -**failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] -**monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] -**maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] -**order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | ## Enum: FailureAction -Name | Value ----- | ----- -failureAction | continue, pause, rollback +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause, rollback | ## Enum: Order -Name | Value ----- | ----- -order | stop-first, start-first +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | diff --git a/api-model-v1-41/docs/ServiceUpdateRequest.md b/api-model-v1-41/docs/ServiceUpdateRequest.md index c6e90d14..17c4c804 100644 --- a/api-model-v1-41/docs/ServiceUpdateRequest.md +++ b/api-model-v1-41/docs/ServiceUpdateRequest.md @@ -2,16 +2,16 @@ # ServiceUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/ServiceUpdateResponse.md b/api-model-v1-41/docs/ServiceUpdateResponse.md index 6de72db5..d131f923 100644 --- a/api-model-v1-41/docs/ServiceUpdateResponse.md +++ b/api-model-v1-41/docs/ServiceUpdateResponse.md @@ -2,9 +2,9 @@ # ServiceUpdateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] | diff --git a/api-model-v1-41/docs/ServiceUpdateStatus.md b/api-model-v1-41/docs/ServiceUpdateStatus.md index f6864e22..be528d9c 100644 --- a/api-model-v1-41/docs/ServiceUpdateStatus.md +++ b/api-model-v1-41/docs/ServiceUpdateStatus.md @@ -2,19 +2,19 @@ # ServiceUpdateStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**state** | [**inline**](#State) | | [optional] -**startedAt** | **kotlin.String** | | [optional] -**completedAt** | **kotlin.String** | | [optional] -**message** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**inline**](#State) | | [optional] | +| **startedAt** | **kotlin.String** | | [optional] | +| **completedAt** | **kotlin.String** | | [optional] | +| **message** | **kotlin.String** | | [optional] | ## Enum: State -Name | Value ----- | ----- -state | updating, paused, completed +| Name | Value | +| ---- | ----- | +| state | updating, paused, completed | diff --git a/api-model-v1-41/docs/Swarm.md b/api-model-v1-41/docs/Swarm.md index b0eb5255..6c752000 100644 --- a/api-model-v1-41/docs/Swarm.md +++ b/api-model-v1-41/docs/Swarm.md @@ -2,19 +2,19 @@ # Swarm ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the swarm. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] -**rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] -**joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] | diff --git a/api-model-v1-41/docs/SwarmInfo.md b/api-model-v1-41/docs/SwarmInfo.md index 9dea5c10..cb655c0b 100644 --- a/api-model-v1-41/docs/SwarmInfo.md +++ b/api-model-v1-41/docs/SwarmInfo.md @@ -2,17 +2,17 @@ # SwarmInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] -**nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] -**localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] -**controlAvailable** | **kotlin.Boolean** | | [optional] -**error** | **kotlin.String** | | [optional] -**remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] -**nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] -**managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] -**cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] | +| **localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] | +| **controlAvailable** | **kotlin.Boolean** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] | +| **nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] | +| **managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] | +| **cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] | diff --git a/api-model-v1-41/docs/SwarmInitRequest.md b/api-model-v1-41/docs/SwarmInitRequest.md index 9c3d9c68..f4503ae3 100644 --- a/api-model-v1-41/docs/SwarmInitRequest.md +++ b/api-model-v1-41/docs/SwarmInitRequest.md @@ -2,16 +2,16 @@ # SwarmInitRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. | [optional] -**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] -**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**forceNewCluster** | **kotlin.Boolean** | Force creation of a new swarm. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **listenAddr** | **kotlin.String** | Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. | [optional] | +| **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] | +| **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **forceNewCluster** | **kotlin.Boolean** | Force creation of a new swarm. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/SwarmJoinRequest.md b/api-model-v1-41/docs/SwarmJoinRequest.md index 5dd4fa1e..854e0fc2 100644 --- a/api-model-v1-41/docs/SwarmJoinRequest.md +++ b/api-model-v1-41/docs/SwarmJoinRequest.md @@ -2,13 +2,13 @@ # SwarmJoinRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] -**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] -**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] -**remoteAddrs** | **kotlin.collections.MutableList<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] -**joinToken** | **kotlin.String** | Secret token for joining this swarm. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] | +| **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] | +| **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] | +| **remoteAddrs** | **kotlin.collections.MutableList<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] | +| **joinToken** | **kotlin.String** | Secret token for joining this swarm. | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpec.md b/api-model-v1-41/docs/SwarmSpec.md index 5a6a4a9f..55042008 100644 --- a/api-model-v1-41/docs/SwarmSpec.md +++ b/api-model-v1-41/docs/SwarmSpec.md @@ -2,16 +2,16 @@ # SwarmSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the swarm. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] -**raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] -**dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] -**caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] -**encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] -**taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the swarm. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] | +| **raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] | +| **dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] | +| **caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] | +| **encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] | +| **taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecCAConfig.md b/api-model-v1-41/docs/SwarmSpecCAConfig.md index 9834a10b..72a0dca2 100644 --- a/api-model-v1-41/docs/SwarmSpecCAConfig.md +++ b/api-model-v1-41/docs/SwarmSpecCAConfig.md @@ -2,13 +2,13 @@ # SwarmSpecCAConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] -**externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] -**signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] -**signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] -**forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] | +| **externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] | +| **signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAsInner.md b/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAsInner.md index b8281c30..d4e29b6c 100644 --- a/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAsInner.md +++ b/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAsInner.md @@ -2,19 +2,19 @@ # SwarmSpecCAConfigExternalCAsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] -**URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] -**caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] | +| **URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] | +| **caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] | ## Enum: Protocol -Name | Value ----- | ----- -protocol | cfssl +| Name | Value | +| ---- | ----- | +| protocol | cfssl | diff --git a/api-model-v1-41/docs/SwarmSpecDispatcher.md b/api-model-v1-41/docs/SwarmSpecDispatcher.md index 3c26d6e3..281781e0 100644 --- a/api-model-v1-41/docs/SwarmSpecDispatcher.md +++ b/api-model-v1-41/docs/SwarmSpecDispatcher.md @@ -2,9 +2,9 @@ # SwarmSpecDispatcher ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecEncryptionConfig.md b/api-model-v1-41/docs/SwarmSpecEncryptionConfig.md index 77123bf9..f26480bf 100644 --- a/api-model-v1-41/docs/SwarmSpecEncryptionConfig.md +++ b/api-model-v1-41/docs/SwarmSpecEncryptionConfig.md @@ -2,9 +2,9 @@ # SwarmSpecEncryptionConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecOrchestration.md b/api-model-v1-41/docs/SwarmSpecOrchestration.md index 39e39025..1152816f 100644 --- a/api-model-v1-41/docs/SwarmSpecOrchestration.md +++ b/api-model-v1-41/docs/SwarmSpecOrchestration.md @@ -2,9 +2,9 @@ # SwarmSpecOrchestration ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecRaft.md b/api-model-v1-41/docs/SwarmSpecRaft.md index 4b288996..c31ecfa2 100644 --- a/api-model-v1-41/docs/SwarmSpecRaft.md +++ b/api-model-v1-41/docs/SwarmSpecRaft.md @@ -2,13 +2,13 @@ # SwarmSpecRaft ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] -**keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] -**logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] -**electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] -**heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] | +| **keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] | +| **logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] | +| **electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | +| **heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecTaskDefaults.md b/api-model-v1-41/docs/SwarmSpecTaskDefaults.md index 499a926b..acb39d26 100644 --- a/api-model-v1-41/docs/SwarmSpecTaskDefaults.md +++ b/api-model-v1-41/docs/SwarmSpecTaskDefaults.md @@ -2,9 +2,9 @@ # SwarmSpecTaskDefaults ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] | diff --git a/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md b/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md index 0f0df03c..8394a880 100644 --- a/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md +++ b/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md @@ -2,10 +2,10 @@ # SwarmSpecTaskDefaultsLogDriver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] | diff --git a/api-model-v1-41/docs/SwarmUnlockRequest.md b/api-model-v1-41/docs/SwarmUnlockRequest.md index ddf81767..0f2b14e8 100644 --- a/api-model-v1-41/docs/SwarmUnlockRequest.md +++ b/api-model-v1-41/docs/SwarmUnlockRequest.md @@ -2,9 +2,9 @@ # SwarmUnlockRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | diff --git a/api-model-v1-41/docs/SystemAuthResponse.md b/api-model-v1-41/docs/SystemAuthResponse.md index 69830deb..8681c17e 100644 --- a/api-model-v1-41/docs/SystemAuthResponse.md +++ b/api-model-v1-41/docs/SystemAuthResponse.md @@ -2,10 +2,10 @@ # SystemAuthResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **kotlin.String** | The status of the authentication | -**identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | **kotlin.String** | The status of the authentication | | +| **identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] | diff --git a/api-model-v1-41/docs/SystemDataUsageResponse.md b/api-model-v1-41/docs/SystemDataUsageResponse.md index 919d9273..36515e99 100644 --- a/api-model-v1-41/docs/SystemDataUsageResponse.md +++ b/api-model-v1-41/docs/SystemDataUsageResponse.md @@ -2,13 +2,13 @@ # SystemDataUsageResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**layersSize** | **kotlin.Long** | | [optional] -**images** | [**kotlin.collections.MutableList<ImageSummary>**](ImageSummary.md) | | [optional] -**containers** | [**kotlin.collections.MutableList<ContainerSummary>**](ContainerSummary.md) | | [optional] -**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | | [optional] -**buildCache** | [**kotlin.collections.MutableList<BuildCache>**](BuildCache.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **layersSize** | **kotlin.Long** | | [optional] | +| **images** | [**kotlin.collections.MutableList<ImageSummary>**](ImageSummary.md) | | [optional] | +| **containers** | [**kotlin.collections.MutableList<ContainerSummary>**](ContainerSummary.md) | | [optional] | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | | [optional] | +| **buildCache** | [**kotlin.collections.MutableList<BuildCache>**](BuildCache.md) | | [optional] | diff --git a/api-model-v1-41/docs/SystemInfo.md b/api-model-v1-41/docs/SystemInfo.md index 02bb9082..5d01e85a 100644 --- a/api-model-v1-41/docs/SystemInfo.md +++ b/api-model-v1-41/docs/SystemInfo.md @@ -2,89 +2,89 @@ # SystemInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] -**containers** | **kotlin.Int** | Total number of containers on the host. | [optional] -**containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] -**containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] -**containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] -**images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] -**driver** | **kotlin.String** | Name of the storage driver in use. | [optional] -**driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] -**dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] -**plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] -**memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] -**swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] -**kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. | [optional] -**cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] -**cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] -**cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] -**cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] -**pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] -**ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] -**bridgeNfIptables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-iptables` is available on the host. | [optional] -**bridgeNfIp6tables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-ip6tables` is available on the host. | [optional] -**debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] -**nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] -**ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] -**systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] -**cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] -**cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] -**neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] -**kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] -**operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] -**osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] -**osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] -**architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] -**NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] -**memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] -**indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] -**registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] -**genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] -**httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] -**httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] -**noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] -**name** | **kotlin.String** | Hostname of the host. | [optional] -**labels** | **kotlin.collections.MutableList<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] -**experimentalBuild** | **kotlin.Boolean** | Indicates if experimental features are enabled on the daemon. | [optional] -**serverVersion** | **kotlin.String** | Version string of the daemon. | [optional] -**runtimes** | [**kotlin.collections.MutableMap<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] -**defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] -**swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] -**liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] -**isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] -**initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] -**containerdCommit** | [**Commit**](Commit.md) | | [optional] -**runcCommit** | [**Commit**](Commit.md) | | [optional] -**initCommit** | [**Commit**](Commit.md) | | [optional] -**securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] -**productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] -**defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] | +| **containers** | **kotlin.Int** | Total number of containers on the host. | [optional] | +| **containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] | +| **containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] | +| **containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] | +| **images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] | +| **driver** | **kotlin.String** | Name of the storage driver in use. | [optional] | +| **driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | +| **dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] | +| **plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] | +| **memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] | +| **swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] | +| **kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. | [optional] | +| **cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] | +| **cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] | +| **cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] | +| **cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] | +| **pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] | +| **ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] | +| **bridgeNfIptables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-iptables` is available on the host. | [optional] | +| **bridgeNfIp6tables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-ip6tables` is available on the host. | [optional] | +| **debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] | +| **nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] | +| **ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] | +| **systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] | +| **cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] | +| **cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] | +| **neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] | +| **kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] | +| **operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] | +| **osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] | +| **osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] | +| **memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] | +| **indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] | +| **registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] | +| **name** | **kotlin.String** | Hostname of the host. | [optional] | +| **labels** | **kotlin.collections.MutableList<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] | +| **experimentalBuild** | **kotlin.Boolean** | Indicates if experimental features are enabled on the daemon. | [optional] | +| **serverVersion** | **kotlin.String** | Version string of the daemon. | [optional] | +| **runtimes** | [**kotlin.collections.MutableMap<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] | +| **defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] | +| **swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] | +| **liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] | +| **isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] | +| **initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **containerdCommit** | [**Commit**](Commit.md) | | [optional] | +| **runcCommit** | [**Commit**](Commit.md) | | [optional] | +| **initCommit** | [**Commit**](Commit.md) | | [optional] | +| **securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] | +| **productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] | +| **defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] | ## Enum: CgroupDriver -Name | Value ----- | ----- -cgroupDriver | cgroupfs, systemd, none +| Name | Value | +| ---- | ----- | +| cgroupDriver | cgroupfs, systemd, none | ## Enum: CgroupVersion -Name | Value ----- | ----- -cgroupVersion | 1, 2 +| Name | Value | +| ---- | ----- | +| cgroupVersion | 1, 2 | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, hyperv, process +| Name | Value | +| ---- | ----- | +| isolation | default, hyperv, process | diff --git a/api-model-v1-41/docs/SystemInfoDefaultAddressPoolsInner.md b/api-model-v1-41/docs/SystemInfoDefaultAddressPoolsInner.md index d24cff78..1db98475 100644 --- a/api-model-v1-41/docs/SystemInfoDefaultAddressPoolsInner.md +++ b/api-model-v1-41/docs/SystemInfoDefaultAddressPoolsInner.md @@ -2,10 +2,10 @@ # SystemInfoDefaultAddressPoolsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**base** | **kotlin.String** | The network address in CIDR format | [optional] -**propertySize** | **kotlin.Int** | The network pool size | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **base** | **kotlin.String** | The network address in CIDR format | [optional] | +| **propertySize** | **kotlin.Int** | The network pool size | [optional] | diff --git a/api-model-v1-41/docs/SystemVersion.md b/api-model-v1-41/docs/SystemVersion.md index ec9c592d..cead3f34 100644 --- a/api-model-v1-41/docs/SystemVersion.md +++ b/api-model-v1-41/docs/SystemVersion.md @@ -2,20 +2,20 @@ # SystemVersion ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] -**components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] -**version** | **kotlin.String** | The version of the daemon | [optional] -**apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] -**minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] -**gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] -**goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] -**os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] -**arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] -**kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] -**experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] -**buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] | +| **components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] | +| **version** | **kotlin.String** | The version of the daemon | [optional] | +| **apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] | +| **minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] | +| **gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] | +| **goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] | +| **os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] | +| **arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] | +| **kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] | +| **experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] | +| **buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] | diff --git a/api-model-v1-41/docs/SystemVersionComponentsInner.md b/api-model-v1-41/docs/SystemVersionComponentsInner.md index d9a2c88f..804428ca 100644 --- a/api-model-v1-41/docs/SystemVersionComponentsInner.md +++ b/api-model-v1-41/docs/SystemVersionComponentsInner.md @@ -2,11 +2,11 @@ # SystemVersionComponentsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the component | -**version** | **kotlin.String** | Version of the component | -**details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the component | | +| **version** | **kotlin.String** | Version of the component | | +| **details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] | diff --git a/api-model-v1-41/docs/SystemVersionPlatform.md b/api-model-v1-41/docs/SystemVersionPlatform.md index 35bad2df..285b4a47 100644 --- a/api-model-v1-41/docs/SystemVersionPlatform.md +++ b/api-model-v1-41/docs/SystemVersionPlatform.md @@ -2,9 +2,9 @@ # SystemVersionPlatform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | diff --git a/api-model-v1-41/docs/TLSInfo.md b/api-model-v1-41/docs/TLSInfo.md index 9b15c9b3..27168d2c 100644 --- a/api-model-v1-41/docs/TLSInfo.md +++ b/api-model-v1-41/docs/TLSInfo.md @@ -2,11 +2,11 @@ # TLSInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] -**certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] -**certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] | +| **certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] | +| **certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] | diff --git a/api-model-v1-41/docs/Task.md b/api-model-v1-41/docs/Task.md index 87037581..f68e5e2f 100644 --- a/api-model-v1-41/docs/Task.md +++ b/api-model-v1-41/docs/Task.md @@ -2,22 +2,22 @@ # Task ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the task. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | Name of the task. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**spec** | [**TaskSpec**](TaskSpec.md) | | [optional] -**serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] -**slot** | **kotlin.Int** | | [optional] -**nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] -**assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] -**status** | [**TaskStatus**](TaskStatus.md) | | [optional] -**desiredState** | [**TaskState**](TaskState.md) | | [optional] -**jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the task. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | Name of the task. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **spec** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] | +| **slot** | **kotlin.Int** | | [optional] | +| **nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] | +| **assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **status** | [**TaskStatus**](TaskStatus.md) | | [optional] | +| **desiredState** | [**TaskState**](TaskState.md) | | [optional] | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpec.md b/api-model-v1-41/docs/TaskSpec.md index b008cdde..bf55bec5 100644 --- a/api-model-v1-41/docs/TaskSpec.md +++ b/api-model-v1-41/docs/TaskSpec.md @@ -2,18 +2,18 @@ # TaskSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] -**containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] -**networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] -**resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] -**restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] -**placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] -**forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] -**runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] -**logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] | +| **containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] | +| **networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] | +| **resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] | +| **restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] | +| **placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] | +| **forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] | +| **runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] | +| **logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpec.md b/api-model-v1-41/docs/TaskSpecContainerSpec.md index 163bc381..886b2b31 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpec.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpec.md @@ -2,42 +2,42 @@ # TaskSpecContainerSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | **kotlin.String** | The image name to use for the container | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] -**command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] -**args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] -**dir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**user** | **kotlin.String** | The user inside the container. | [optional] -**groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] -**privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] -**TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] -**mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] -**stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] -**healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] -**dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] -**secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] -**configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] -**isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] -**capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] -**capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **image** | **kotlin.String** | The image name to use for the container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] | +| **command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] | +| **dir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **user** | **kotlin.String** | The user inside the container. | [optional] | +| **groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] | +| **TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] | +| **stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] | +| **healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] | +| **dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] | +| **secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] | +| **configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] | +| **capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] | +| **capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, process, hyperv +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInner.md b/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInner.md index ce88a95c..b3fd4ce2 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInner.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInner.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecConfigsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] -**runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] -**configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] -**configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] | +| **runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] | +| **configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] | +| **configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInnerFile.md b/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInnerFile.md index 7013e04f..8d06a999 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInnerFile.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecConfigsInnerFile.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecConfigsInnerFile ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] -**UID** | **kotlin.String** | UID represents the file UID. | [optional] -**GID** | **kotlin.String** | GID represents the file GID. | [optional] -**mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md b/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md index 75bff49a..e2f2192a 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecDNSConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] -**search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] -**options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] | +| **search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecPrivileges.md b/api-model-v1-41/docs/TaskSpecContainerSpecPrivileges.md index 99a5c311..641f2f81 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecPrivileges.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecPrivileges.md @@ -2,10 +2,10 @@ # TaskSpecContainerSpecPrivileges ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] -**seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] | +| **seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md b/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md index 169c37fe..427e0c31 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecPrivilegesCredentialSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] -**file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] -**registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md b/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md index a5e466e8..996b8470 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md @@ -2,13 +2,13 @@ # TaskSpecContainerSpecPrivilegesSELinuxContext ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**disable** | **kotlin.Boolean** | Disable SELinux | [optional] -**user** | **kotlin.String** | SELinux user label | [optional] -**role** | **kotlin.String** | SELinux role label | [optional] -**type** | **kotlin.String** | SELinux type label | [optional] -**level** | **kotlin.String** | SELinux level label | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **disable** | **kotlin.Boolean** | Disable SELinux | [optional] | +| **user** | **kotlin.String** | SELinux user label | [optional] | +| **role** | **kotlin.String** | SELinux role label | [optional] | +| **type** | **kotlin.String** | SELinux type label | [optional] | +| **level** | **kotlin.String** | SELinux level label | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInner.md b/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInner.md index e20b3a06..11d5721e 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInner.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInner.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecSecretsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] -**secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] -**secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] | +| **secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] | +| **secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInnerFile.md b/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInnerFile.md index af42e3f3..c90d914f 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInnerFile.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecSecretsInnerFile.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecSecretsInnerFile ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] -**UID** | **kotlin.String** | UID represents the file UID. | [optional] -**GID** | **kotlin.String** | GID represents the file GID. | [optional] -**mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecLogDriver.md b/api-model-v1-41/docs/TaskSpecLogDriver.md index a0cfb139..be81c423 100644 --- a/api-model-v1-41/docs/TaskSpecLogDriver.md +++ b/api-model-v1-41/docs/TaskSpecLogDriver.md @@ -2,10 +2,10 @@ # TaskSpecLogDriver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecNetworkAttachmentSpec.md b/api-model-v1-41/docs/TaskSpecNetworkAttachmentSpec.md index 1b6fcbe5..ae098a2f 100644 --- a/api-model-v1-41/docs/TaskSpecNetworkAttachmentSpec.md +++ b/api-model-v1-41/docs/TaskSpecNetworkAttachmentSpec.md @@ -2,9 +2,9 @@ # TaskSpecNetworkAttachmentSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containerID** | **kotlin.String** | ID of the container represented by this task | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | ID of the container represented by this task | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecPlacement.md b/api-model-v1-41/docs/TaskSpecPlacement.md index 8477a6fe..0b5caddb 100644 --- a/api-model-v1-41/docs/TaskSpecPlacement.md +++ b/api-model-v1-41/docs/TaskSpecPlacement.md @@ -2,12 +2,12 @@ # TaskSpecPlacement ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] -**preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] -**maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] -**platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] | +| **preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] | +| **maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] | +| **platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecPlacementPreferencesInner.md b/api-model-v1-41/docs/TaskSpecPlacementPreferencesInner.md index a5f6f559..2894f7e5 100644 --- a/api-model-v1-41/docs/TaskSpecPlacementPreferencesInner.md +++ b/api-model-v1-41/docs/TaskSpecPlacementPreferencesInner.md @@ -2,9 +2,9 @@ # TaskSpecPlacementPreferencesInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecPlacementPreferencesInnerSpread.md b/api-model-v1-41/docs/TaskSpecPlacementPreferencesInnerSpread.md index c1d686b6..9643c6ae 100644 --- a/api-model-v1-41/docs/TaskSpecPlacementPreferencesInnerSpread.md +++ b/api-model-v1-41/docs/TaskSpecPlacementPreferencesInnerSpread.md @@ -2,9 +2,9 @@ # TaskSpecPlacementPreferencesInnerSpread ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecPluginSpec.md b/api-model-v1-41/docs/TaskSpecPluginSpec.md index 7adb8c81..45eb9382 100644 --- a/api-model-v1-41/docs/TaskSpecPluginSpec.md +++ b/api-model-v1-41/docs/TaskSpecPluginSpec.md @@ -2,12 +2,12 @@ # TaskSpecPluginSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] -**remote** | **kotlin.String** | The plugin image reference to use. | [optional] -**disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] -**pluginPrivilege** | [**kotlin.collections.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] | +| **remote** | **kotlin.String** | The plugin image reference to use. | [optional] | +| **disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] | +| **pluginPrivilege** | [**kotlin.collections.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecResources.md b/api-model-v1-41/docs/TaskSpecResources.md index 7ac6cc70..531e9943 100644 --- a/api-model-v1-41/docs/TaskSpecResources.md +++ b/api-model-v1-41/docs/TaskSpecResources.md @@ -2,10 +2,10 @@ # TaskSpecResources ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limits** | [**Limit**](Limit.md) | | [optional] -**reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **limits** | [**Limit**](Limit.md) | | [optional] | +| **reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] | diff --git a/api-model-v1-41/docs/TaskSpecRestartPolicy.md b/api-model-v1-41/docs/TaskSpecRestartPolicy.md index 747d8ee4..d139ec81 100644 --- a/api-model-v1-41/docs/TaskSpecRestartPolicy.md +++ b/api-model-v1-41/docs/TaskSpecRestartPolicy.md @@ -2,19 +2,19 @@ # TaskSpecRestartPolicy ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**condition** | [**inline**](#Condition) | Condition for restart. | [optional] -**delay** | **kotlin.Long** | Delay between restart attempts. | [optional] -**maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] -**window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **condition** | [**inline**](#Condition) | Condition for restart. | [optional] | +| **delay** | **kotlin.Long** | Delay between restart attempts. | [optional] | +| **maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] | +| **window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] | ## Enum: Condition -Name | Value ----- | ----- -condition | none, on-failure, any +| Name | Value | +| ---- | ----- | +| condition | none, on-failure, any | diff --git a/api-model-v1-41/docs/TaskStatus.md b/api-model-v1-41/docs/TaskStatus.md index 9129650b..347db437 100644 --- a/api-model-v1-41/docs/TaskStatus.md +++ b/api-model-v1-41/docs/TaskStatus.md @@ -2,14 +2,14 @@ # TaskStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**timestamp** | **kotlin.String** | | [optional] -**state** | [**TaskState**](TaskState.md) | | [optional] -**message** | **kotlin.String** | | [optional] -**err** | **kotlin.String** | | [optional] -**containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] -**portStatus** | [**PortStatus**](PortStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **timestamp** | **kotlin.String** | | [optional] | +| **state** | [**TaskState**](TaskState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **err** | **kotlin.String** | | [optional] | +| **containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] | +| **portStatus** | [**PortStatus**](PortStatus.md) | | [optional] | diff --git a/api-model-v1-41/docs/ThrottleDevice.md b/api-model-v1-41/docs/ThrottleDevice.md index 6fedc91a..a4dbeb34 100644 --- a/api-model-v1-41/docs/ThrottleDevice.md +++ b/api-model-v1-41/docs/ThrottleDevice.md @@ -2,10 +2,10 @@ # ThrottleDevice ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Device path | [optional] -**rate** | **kotlin.Long** | Rate | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Device path | [optional] | +| **rate** | **kotlin.Long** | Rate | [optional] | diff --git a/api-model-v1-41/docs/UnlockKeyResponse.md b/api-model-v1-41/docs/UnlockKeyResponse.md index f2d7fe19..e530f063 100644 --- a/api-model-v1-41/docs/UnlockKeyResponse.md +++ b/api-model-v1-41/docs/UnlockKeyResponse.md @@ -2,9 +2,9 @@ # UnlockKeyResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | diff --git a/api-model-v1-41/docs/Volume.md b/api-model-v1-41/docs/Volume.md index 836fe611..25fce51e 100644 --- a/api-model-v1-41/docs/Volume.md +++ b/api-model-v1-41/docs/Volume.md @@ -2,25 +2,25 @@ # Volume ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the volume. | -**driver** | **kotlin.String** | Name of the volume driver used by the volume. | -**mountpoint** | **kotlin.String** | Mount path of the volume on the host. | -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | -**createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] -**status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] -**clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] -**usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the volume. | | +| **driver** | **kotlin.String** | Name of the volume driver used by the volume. | | +| **mountpoint** | **kotlin.String** | Mount path of the volume on the host. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | | +| **createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] | +| **status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] | +| **clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] | +| **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] | ## Enum: Scope -Name | Value ----- | ----- -scope | local, global +| Name | Value | +| ---- | ----- | +| scope | local, global | diff --git a/api-model-v1-41/docs/VolumeCreateOptions.md b/api-model-v1-41/docs/VolumeCreateOptions.md index 5fb7d701..e6402768 100644 --- a/api-model-v1-41/docs/VolumeCreateOptions.md +++ b/api-model-v1-41/docs/VolumeCreateOptions.md @@ -2,13 +2,13 @@ # VolumeCreateOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] -**driver** | **kotlin.String** | Name of the volume driver to use. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] | +| **driver** | **kotlin.String** | Name of the volume driver to use. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/VolumeListResponse.md b/api-model-v1-41/docs/VolumeListResponse.md index 55a70700..832e8349 100644 --- a/api-model-v1-41/docs/VolumeListResponse.md +++ b/api-model-v1-41/docs/VolumeListResponse.md @@ -2,10 +2,10 @@ # VolumeListResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] | diff --git a/api-model-v1-41/docs/VolumePruneResponse.md b/api-model-v1-41/docs/VolumePruneResponse.md index bd4d15c5..e1b6e248 100644 --- a/api-model-v1-41/docs/VolumePruneResponse.md +++ b/api-model-v1-41/docs/VolumePruneResponse.md @@ -2,10 +2,10 @@ # VolumePruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-41/docs/VolumeUpdateRequest.md b/api-model-v1-41/docs/VolumeUpdateRequest.md index a4b0a8de..8988303b 100644 --- a/api-model-v1-41/docs/VolumeUpdateRequest.md +++ b/api-model-v1-41/docs/VolumeUpdateRequest.md @@ -2,9 +2,9 @@ # VolumeUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | diff --git a/api-model-v1-41/docs/VolumeUsageData.md b/api-model-v1-41/docs/VolumeUsageData.md index 2f9df591..442e3a02 100644 --- a/api-model-v1-41/docs/VolumeUsageData.md +++ b/api-model-v1-41/docs/VolumeUsageData.md @@ -2,10 +2,10 @@ # VolumeUsageData ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | -**refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | | +| **refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | | diff --git a/api-model-v1-45/.openapi-generator/VERSION b/api-model-v1-45/.openapi-generator/VERSION index 93c8ddab..1985849f 100644 --- a/api-model-v1-45/.openapi-generator/VERSION +++ b/api-model-v1-45/.openapi-generator/VERSION @@ -1 +1 @@ -7.6.0 +7.7.0 diff --git a/api-model-v1-45/README.md b/api-model-v1-45/README.md index 802462da..374b0f80 100644 --- a/api-model-v1-45/README.md +++ b/api-model-v1-45/README.md @@ -78,7 +78,7 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat - API version: 1.45 - Package version: -- Generator version: 7.6.0 +- Generator version: 7.7.0 - Build package: org.openapitools.codegen.languages.KotlinClientCodegen ## Requires @@ -114,115 +114,115 @@ This runs all tests and packages the library. All URIs are relative to *http://localhost/v1.45* -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config -*ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config -*ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config -*ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs -*ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config -*ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container -*ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container -*ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container -*ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket -*ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem -*ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container -*ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container -*ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container -*ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container -*ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container -*ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers -*ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs -*ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container -*ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers -*ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container -*ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY -*ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container -*ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container -*ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage -*ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container -*ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container -*ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container -*ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container -*ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container -*ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container -*DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry -*ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance -*ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance -*ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance -*ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance -*ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache -*ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image -*ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container -*ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image -*ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image -*ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image -*ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images -*ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image -*ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image -*ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images -*ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images -*ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images -*ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image -*ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images -*ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image -*NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network -*NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network -*NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network -*NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network -*NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network -*NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks -*NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks -*NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node -*NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node -*NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes -*NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node -*PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges -*PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin -*PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin -*PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin -*PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin -*PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin -*PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins -*PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin -*PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin -*PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin -*PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin -*SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret -*SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret -*SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret -*SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets -*SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret -*ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service -*ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service -*ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service -*ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services -*ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs -*ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service -*SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session -*SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm -*SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm -*SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm -*SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm -*SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager -*SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key -*SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm -*SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration -*SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information -*SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events -*SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information -*SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping -*SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping -*SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version -*TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task -*TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks -*TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs -*VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume -*VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume -*VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume -*VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes -*VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes -*VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" +| Class | Method | HTTP request | Description | +| ------------ | ------------- | ------------- | ------------- | +| *ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config | +| *ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config | +| *ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config | +| *ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs | +| *ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config | +| *ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container | +| *ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container | +| *ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container | +| *ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket | +| *ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem | +| *ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container | +| *ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container | +| *ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container | +| *ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container | +| *ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container | +| *ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers | +| *ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs | +| *ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container | +| *ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers | +| *ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container | +| *ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY | +| *ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container | +| *ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container | +| *ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage | +| *ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container | +| *ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container | +| *ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container | +| *ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container | +| *ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container | +| *ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container | +| *DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry | +| *ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance | +| *ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance | +| *ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance | +| *ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance | +| *ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache | +| *ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image | +| *ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container | +| *ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image | +| *ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image | +| *ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image | +| *ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images | +| *ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image | +| *ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image | +| *ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images | +| *ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images | +| *ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images | +| *ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image | +| *ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images | +| *ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image | +| *NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network | +| *NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network | +| *NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network | +| *NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network | +| *NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network | +| *NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks | +| *NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks | +| *NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node | +| *NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node | +| *NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes | +| *NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node | +| *PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges | +| *PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin | +| *PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin | +| *PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin | +| *PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin | +| *PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin | +| *PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins | +| *PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin | +| *PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin | +| *PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin | +| *PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin | +| *SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret | +| *SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret | +| *SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret | +| *SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets | +| *SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret | +| *ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service | +| *ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service | +| *ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service | +| *ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services | +| *ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs | +| *ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service | +| *SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session | +| *SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm | +| *SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm | +| *SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm | +| *SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm | +| *SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager | +| *SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key | +| *SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm | +| *SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration | +| *SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information | +| *SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events | +| *SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information | +| *SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping | +| *SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping | +| *SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version | +| *TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task | +| *TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks | +| *TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs | +| *VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume | +| *VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume | +| *VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume | +| *VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes | +| *VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes | +| *VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" | diff --git a/api-model-v1-45/docs/Address.md b/api-model-v1-45/docs/Address.md index b34db1ad..0b2b6f74 100644 --- a/api-model-v1-45/docs/Address.md +++ b/api-model-v1-45/docs/Address.md @@ -2,10 +2,10 @@ # Address ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**addr** | **kotlin.String** | IP address. | [optional] -**prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **addr** | **kotlin.String** | IP address. | [optional] | +| **prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] | diff --git a/api-model-v1-45/docs/AuthConfig.md b/api-model-v1-45/docs/AuthConfig.md index f50a3d54..c9539dd7 100644 --- a/api-model-v1-45/docs/AuthConfig.md +++ b/api-model-v1-45/docs/AuthConfig.md @@ -2,12 +2,12 @@ # AuthConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**username** | **kotlin.String** | | [optional] -**password** | **kotlin.String** | | [optional] -**email** | **kotlin.String** | | [optional] -**serveraddress** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **username** | **kotlin.String** | | [optional] | +| **password** | **kotlin.String** | | [optional] | +| **email** | **kotlin.String** | | [optional] | +| **serveraddress** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/BuildCache.md b/api-model-v1-45/docs/BuildCache.md index a1421c37..719351e8 100644 --- a/api-model-v1-45/docs/BuildCache.md +++ b/api-model-v1-45/docs/BuildCache.md @@ -2,26 +2,26 @@ # BuildCache ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] -**parent** | **kotlin.String** | ID of the parent build cache record. > **Deprecated**: This field is deprecated, and omitted if empty. | [optional] -**parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] -**type** | [**inline**](#Type) | Cache record type. | [optional] -**description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] -**inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] -**shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] -**propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] -**createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**usageCount** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] | +| **parent** | **kotlin.String** | ID of the parent build cache record. > **Deprecated**: This field is deprecated, and omitted if empty. | [optional] | +| **parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] | +| **type** | [**inline**](#Type) | Cache record type. | [optional] | +| **description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] | +| **inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] | +| **shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] | +| **propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **usageCount** | **kotlin.Int** | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular +| Name | Value | +| ---- | ----- | +| type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular | diff --git a/api-model-v1-45/docs/BuildInfo.md b/api-model-v1-45/docs/BuildInfo.md index 00f51c03..7adad3f3 100644 --- a/api-model-v1-45/docs/BuildInfo.md +++ b/api-model-v1-45/docs/BuildInfo.md @@ -2,16 +2,16 @@ # BuildInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | [optional] -**stream** | **kotlin.String** | | [optional] -**error** | **kotlin.String** | | [optional] -**errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] -**aux** | [**ImageID**](ImageID.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **stream** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | +| **aux** | [**ImageID**](ImageID.md) | | [optional] | diff --git a/api-model-v1-45/docs/BuildPruneResponse.md b/api-model-v1-45/docs/BuildPruneResponse.md index 34efd422..99595843 100644 --- a/api-model-v1-45/docs/BuildPruneResponse.md +++ b/api-model-v1-45/docs/BuildPruneResponse.md @@ -2,10 +2,10 @@ # BuildPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-45/docs/ClusterInfo.md b/api-model-v1-45/docs/ClusterInfo.md index 1f70cac7..c7f6c112 100644 --- a/api-model-v1-45/docs/ClusterInfo.md +++ b/api-model-v1-45/docs/ClusterInfo.md @@ -2,18 +2,18 @@ # ClusterInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the swarm. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] -**rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolume.md b/api-model-v1-45/docs/ClusterVolume.md index 85ef2a29..da0a33cf 100644 --- a/api-model-v1-45/docs/ClusterVolume.md +++ b/api-model-v1-45/docs/ClusterVolume.md @@ -2,15 +2,15 @@ # ClusterVolume ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] -**info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] -**publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | +| **info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] | +| **publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolumeInfo.md b/api-model-v1-45/docs/ClusterVolumeInfo.md index 88fe512b..55fef034 100644 --- a/api-model-v1-45/docs/ClusterVolumeInfo.md +++ b/api-model-v1-45/docs/ClusterVolumeInfo.md @@ -2,12 +2,12 @@ # ClusterVolumeInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] -**volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] -**volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] -**accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] | +| **volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] | +| **volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] | +| **accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolumePublishStatusInner.md b/api-model-v1-45/docs/ClusterVolumePublishStatusInner.md index 7d3823c3..96142792 100644 --- a/api-model-v1-45/docs/ClusterVolumePublishStatusInner.md +++ b/api-model-v1-45/docs/ClusterVolumePublishStatusInner.md @@ -2,18 +2,18 @@ # ClusterVolumePublishStatusInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] -**state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] -**publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] | +| **state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] | +| **publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] | ## Enum: State -Name | Value ----- | ----- -state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish +| Name | Value | +| ---- | ----- | +| state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish | diff --git a/api-model-v1-45/docs/ClusterVolumeSpec.md b/api-model-v1-45/docs/ClusterVolumeSpec.md index 81fc4829..670b70e0 100644 --- a/api-model-v1-45/docs/ClusterVolumeSpec.md +++ b/api-model-v1-45/docs/ClusterVolumeSpec.md @@ -2,10 +2,10 @@ # ClusterVolumeSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] -**accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] | +| **accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolumeSpecAccessMode.md b/api-model-v1-45/docs/ClusterVolumeSpecAccessMode.md index 7fe2e4c5..37eb7734 100644 --- a/api-model-v1-45/docs/ClusterVolumeSpecAccessMode.md +++ b/api-model-v1-45/docs/ClusterVolumeSpecAccessMode.md @@ -2,36 +2,36 @@ # ClusterVolumeSpecAccessMode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] -**sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] -**mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] -**secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] -**accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] -**capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] -**availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] | +| **sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] | +| **mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] | +| **secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] | +| **accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] | +| **capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] | +| **availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] | ## Enum: Scope -Name | Value ----- | ----- -scope | single, multi +| Name | Value | +| ---- | ----- | +| scope | single, multi | ## Enum: Sharing -Name | Value ----- | ----- -sharing | none, readonly, onewriter, all +| Name | Value | +| ---- | ----- | +| sharing | none, readonly, onewriter, all | ## Enum: Availability -Name | Value ----- | ----- -availability | active, pause, drain +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | diff --git a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md index 1b25bf93..fe071a5d 100644 --- a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md +++ b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeAccessibilityRequirements ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] -**preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] | +| **preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeCapacityRange.md b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeCapacityRange.md index 1dcceba8..6ed01224 100644 --- a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeCapacityRange.md +++ b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeCapacityRange.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeCapacityRange ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] -**limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] | +| **limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] | diff --git a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeSecretsInner.md b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeSecretsInner.md index 92397c7b..608a6876 100644 --- a/api-model-v1-45/docs/ClusterVolumeSpecAccessModeSecretsInner.md +++ b/api-model-v1-45/docs/ClusterVolumeSpecAccessModeSecretsInner.md @@ -2,10 +2,10 @@ # ClusterVolumeSpecAccessModeSecretsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] -**secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] | +| **secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] | diff --git a/api-model-v1-45/docs/Commit.md b/api-model-v1-45/docs/Commit.md index 142fab5d..db8ec2f9 100644 --- a/api-model-v1-45/docs/Commit.md +++ b/api-model-v1-45/docs/Commit.md @@ -2,10 +2,10 @@ # Commit ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] -**expected** | **kotlin.String** | Commit ID of external tool expected by dockerd as set at build time. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] | +| **expected** | **kotlin.String** | Commit ID of external tool expected by dockerd as set at build time. | [optional] | diff --git a/api-model-v1-45/docs/Config.md b/api-model-v1-45/docs/Config.md index bcc9d623..5174c406 100644 --- a/api-model-v1-45/docs/Config.md +++ b/api-model-v1-45/docs/Config.md @@ -2,13 +2,13 @@ # Config ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/ConfigCreateRequest.md b/api-model-v1-45/docs/ConfigCreateRequest.md index fe14855f..b237b0d5 100644 --- a/api-model-v1-45/docs/ConfigCreateRequest.md +++ b/api-model-v1-45/docs/ConfigCreateRequest.md @@ -2,12 +2,12 @@ # ConfigCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the config. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-45/docs/ConfigSpec.md b/api-model-v1-45/docs/ConfigSpec.md index 2def499f..4846145d 100644 --- a/api-model-v1-45/docs/ConfigSpec.md +++ b/api-model-v1-45/docs/ConfigSpec.md @@ -2,12 +2,12 @@ # ConfigSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the config. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerConfig.md b/api-model-v1-45/docs/ContainerConfig.md index 91eba8cf..06a2c65b 100644 --- a/api-model-v1-45/docs/ContainerConfig.md +++ b/api-model-v1-45/docs/ContainerConfig.md @@ -2,33 +2,33 @@ # ContainerConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] -**domainname** | **kotlin.String** | The domain name to use for the container. | [optional] -**user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] -**attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] -**attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] -**attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] -**exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] -**tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] -**healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] -**image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] -**volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] -**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] -**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] -**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] -**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] -**stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] -**shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | diff --git a/api-model-v1-45/docs/ContainerCreateRequest.md b/api-model-v1-45/docs/ContainerCreateRequest.md index 1231ac50..14e964f9 100644 --- a/api-model-v1-45/docs/ContainerCreateRequest.md +++ b/api-model-v1-45/docs/ContainerCreateRequest.md @@ -2,35 +2,35 @@ # ContainerCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] -**domainname** | **kotlin.String** | The domain name to use for the container. | [optional] -**user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] -**attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] -**attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] -**attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] -**exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] -**tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] -**healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] -**image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] -**volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] -**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] -**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] -**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] -**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] -**stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] -**shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] -**hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] -**networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerCreateResponse.md b/api-model-v1-45/docs/ContainerCreateResponse.md index 3c3788da..2470f713 100644 --- a/api-model-v1-45/docs/ContainerCreateResponse.md +++ b/api-model-v1-45/docs/ContainerCreateResponse.md @@ -2,10 +2,10 @@ # ContainerCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the created container | -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created container | | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] | diff --git a/api-model-v1-45/docs/ContainerInspectResponse.md b/api-model-v1-45/docs/ContainerInspectResponse.md index 69344bc7..f4cf96a4 100644 --- a/api-model-v1-45/docs/ContainerInspectResponse.md +++ b/api-model-v1-45/docs/ContainerInspectResponse.md @@ -2,33 +2,33 @@ # ContainerInspectResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the container | [optional] -**created** | **kotlin.String** | The time the container was created | [optional] -**path** | **kotlin.String** | The path to the command being run | [optional] -**args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] -**state** | [**ContainerState**](ContainerState.md) | | [optional] -**image** | **kotlin.String** | The container's image ID | [optional] -**resolvConfPath** | **kotlin.String** | | [optional] -**hostnamePath** | **kotlin.String** | | [optional] -**hostsPath** | **kotlin.String** | | [optional] -**logPath** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | | [optional] -**restartCount** | **kotlin.Int** | | [optional] -**driver** | **kotlin.String** | | [optional] -**platform** | **kotlin.String** | | [optional] -**mountLabel** | **kotlin.String** | | [optional] -**processLabel** | **kotlin.String** | | [optional] -**appArmorProfile** | **kotlin.String** | | [optional] -**execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] -**hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] -**graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] -**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. | [optional] -**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container. | [optional] -**mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] -**config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the container | [optional] | +| **created** | **kotlin.String** | The time the container was created | [optional] | +| **path** | **kotlin.String** | The path to the command being run | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] | +| **state** | [**ContainerState**](ContainerState.md) | | [optional] | +| **image** | **kotlin.String** | The container's image ID | [optional] | +| **resolvConfPath** | **kotlin.String** | | [optional] | +| **hostnamePath** | **kotlin.String** | | [optional] | +| **hostsPath** | **kotlin.String** | | [optional] | +| **logPath** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **restartCount** | **kotlin.Int** | | [optional] | +| **driver** | **kotlin.String** | | [optional] | +| **platform** | **kotlin.String** | | [optional] | +| **mountLabel** | **kotlin.String** | | [optional] | +| **processLabel** | **kotlin.String** | | [optional] | +| **appArmorProfile** | **kotlin.String** | | [optional] | +| **execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all the files in this container. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerPruneResponse.md b/api-model-v1-45/docs/ContainerPruneResponse.md index 6b259d16..d498e282 100644 --- a/api-model-v1-45/docs/ContainerPruneResponse.md +++ b/api-model-v1-45/docs/ContainerPruneResponse.md @@ -2,10 +2,10 @@ # ContainerPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-45/docs/ContainerState.md b/api-model-v1-45/docs/ContainerState.md index 50cb7bd5..85d232e5 100644 --- a/api-model-v1-45/docs/ContainerState.md +++ b/api-model-v1-45/docs/ContainerState.md @@ -2,27 +2,27 @@ # ContainerState ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] -**running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] -**paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] -**restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] -**ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] -**dead** | **kotlin.Boolean** | | [optional] -**pid** | **kotlin.Int** | The process ID of this container | [optional] -**exitCode** | **kotlin.Int** | The last exit code of this container | [optional] -**error** | **kotlin.String** | | [optional] -**startedAt** | **kotlin.String** | The time when this container was last started. | [optional] -**finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] -**health** | [**Health**](Health.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] | +| **running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] | +| **paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] | +| **restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] | +| **ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] | +| **dead** | **kotlin.Boolean** | | [optional] | +| **pid** | **kotlin.Int** | The process ID of this container | [optional] | +| **exitCode** | **kotlin.Int** | The last exit code of this container | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **startedAt** | **kotlin.String** | The time when this container was last started. | [optional] | +| **finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] | +| **health** | [**Health**](Health.md) | | [optional] | ## Enum: Status -Name | Value ----- | ----- -status | created, running, paused, restarting, removing, exited, dead +| Name | Value | +| ---- | ----- | +| status | created, running, paused, restarting, removing, exited, dead | diff --git a/api-model-v1-45/docs/ContainerStatus.md b/api-model-v1-45/docs/ContainerStatus.md index e02765e7..b58e6e86 100644 --- a/api-model-v1-45/docs/ContainerStatus.md +++ b/api-model-v1-45/docs/ContainerStatus.md @@ -2,11 +2,11 @@ # ContainerStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containerID** | **kotlin.String** | | [optional] -**PID** | **kotlin.Int** | | [optional] -**exitCode** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | | [optional] | +| **PID** | **kotlin.Int** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/ContainerSummary.md b/api-model-v1-45/docs/ContainerSummary.md index 86afc47d..0701022d 100644 --- a/api-model-v1-45/docs/ContainerSummary.md +++ b/api-model-v1-45/docs/ContainerSummary.md @@ -2,23 +2,23 @@ # ContainerSummary ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of this container | [optional] -**names** | **kotlin.collections.MutableList<kotlin.String>** | The names that this container has been given | [optional] -**image** | **kotlin.String** | The name of the image used when creating this container | [optional] -**imageID** | **kotlin.String** | The ID of the image that this container was created from | [optional] -**command** | **kotlin.String** | Command to run when starting the container | [optional] -**created** | **kotlin.Long** | When the container was created | [optional] -**ports** | [**kotlin.collections.MutableList<Port>**](Port.md) | The ports exposed by this container | [optional] -**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container | [optional] -**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**state** | **kotlin.String** | The state of this container (e.g. `Exited`) | [optional] -**status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) | [optional] -**hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) | | [optional] -**networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) | | [optional] -**mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of this container | [optional] | +| **names** | **kotlin.collections.MutableList<kotlin.String>** | The names that this container has been given | [optional] | +| **image** | **kotlin.String** | The name of the image used when creating this container | [optional] | +| **imageID** | **kotlin.String** | The ID of the image that this container was created from | [optional] | +| **command** | **kotlin.String** | Command to run when starting the container | [optional] | +| **created** | **kotlin.Long** | When the container was created | [optional] | +| **ports** | [**kotlin.collections.MutableList<Port>**](Port.md) | The ports exposed by this container | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all the files in this container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **state** | **kotlin.String** | The state of this container (e.g. `Exited`) | [optional] | +| **status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) | [optional] | +| **hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) | | [optional] | +| **networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) | | [optional] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerSummaryHostConfig.md b/api-model-v1-45/docs/ContainerSummaryHostConfig.md index 165a27a8..646ecc02 100644 --- a/api-model-v1-45/docs/ContainerSummaryHostConfig.md +++ b/api-model-v1-45/docs/ContainerSummaryHostConfig.md @@ -2,9 +2,9 @@ # ContainerSummaryHostConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networkMode** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkMode** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/ContainerSummaryNetworkSettings.md b/api-model-v1-45/docs/ContainerSummaryNetworkSettings.md index acb7fec6..976bd525 100644 --- a/api-model-v1-45/docs/ContainerSummaryNetworkSettings.md +++ b/api-model-v1-45/docs/ContainerSummaryNetworkSettings.md @@ -2,9 +2,9 @@ # ContainerSummaryNetworkSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerTopResponse.md b/api-model-v1-45/docs/ContainerTopResponse.md index ef42e8be..2be83bc3 100644 --- a/api-model-v1-45/docs/ContainerTopResponse.md +++ b/api-model-v1-45/docs/ContainerTopResponse.md @@ -2,10 +2,10 @@ # ContainerTopResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] -**processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] | +| **processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] | diff --git a/api-model-v1-45/docs/ContainerUpdateRequest.md b/api-model-v1-45/docs/ContainerUpdateRequest.md index 8afa71a5..44b57d97 100644 --- a/api-model-v1-45/docs/ContainerUpdateRequest.md +++ b/api-model-v1-45/docs/ContainerUpdateRequest.md @@ -2,40 +2,40 @@ # ContainerUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] -**restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | diff --git a/api-model-v1-45/docs/ContainerUpdateResponse.md b/api-model-v1-45/docs/ContainerUpdateResponse.md index 067f8a6f..d8314d37 100644 --- a/api-model-v1-45/docs/ContainerUpdateResponse.md +++ b/api-model-v1-45/docs/ContainerUpdateResponse.md @@ -2,9 +2,9 @@ # ContainerUpdateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/ContainerWaitExitError.md b/api-model-v1-45/docs/ContainerWaitExitError.md index 9891f878..42bceba4 100644 --- a/api-model-v1-45/docs/ContainerWaitExitError.md +++ b/api-model-v1-45/docs/ContainerWaitExitError.md @@ -2,9 +2,9 @@ # ContainerWaitExitError ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **kotlin.String** | Details of an error | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | Details of an error | [optional] | diff --git a/api-model-v1-45/docs/ContainerWaitResponse.md b/api-model-v1-45/docs/ContainerWaitResponse.md index 61ccd4a9..8e2eea9b 100644 --- a/api-model-v1-45/docs/ContainerWaitResponse.md +++ b/api-model-v1-45/docs/ContainerWaitResponse.md @@ -2,10 +2,10 @@ # ContainerWaitResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**statusCode** | **kotlin.Long** | Exit code of the container | -**error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **statusCode** | **kotlin.Long** | Exit code of the container | | +| **error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] | diff --git a/api-model-v1-45/docs/CreateImageInfo.md b/api-model-v1-45/docs/CreateImageInfo.md index c3f1a7fd..1672d321 100644 --- a/api-model-v1-45/docs/CreateImageInfo.md +++ b/api-model-v1-45/docs/CreateImageInfo.md @@ -2,14 +2,14 @@ # CreateImageInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | [optional] -**error** | **kotlin.String** | | [optional] -**errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | diff --git a/api-model-v1-45/docs/DeviceMapping.md b/api-model-v1-45/docs/DeviceMapping.md index a229d63a..d90a503a 100644 --- a/api-model-v1-45/docs/DeviceMapping.md +++ b/api-model-v1-45/docs/DeviceMapping.md @@ -2,11 +2,11 @@ # DeviceMapping ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pathOnHost** | **kotlin.String** | | [optional] -**pathInContainer** | **kotlin.String** | | [optional] -**cgroupPermissions** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pathOnHost** | **kotlin.String** | | [optional] | +| **pathInContainer** | **kotlin.String** | | [optional] | +| **cgroupPermissions** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/DeviceRequest.md b/api-model-v1-45/docs/DeviceRequest.md index d481fa41..e54c22ac 100644 --- a/api-model-v1-45/docs/DeviceRequest.md +++ b/api-model-v1-45/docs/DeviceRequest.md @@ -2,13 +2,13 @@ # DeviceRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**driver** | **kotlin.String** | | [optional] -**count** | **kotlin.Int** | | [optional] -**deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | | [optional] | +| **count** | **kotlin.Int** | | [optional] | +| **deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] | diff --git a/api-model-v1-45/docs/DistributionInspect.md b/api-model-v1-45/docs/DistributionInspect.md index 15df91fd..fef111c5 100644 --- a/api-model-v1-45/docs/DistributionInspect.md +++ b/api-model-v1-45/docs/DistributionInspect.md @@ -2,10 +2,10 @@ # DistributionInspect ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | -**platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | | +| **platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | | diff --git a/api-model-v1-45/docs/Driver.md b/api-model-v1-45/docs/Driver.md index 51c7a732..1d98106e 100644 --- a/api-model-v1-45/docs/Driver.md +++ b/api-model-v1-45/docs/Driver.md @@ -2,10 +2,10 @@ # Driver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the driver. | -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] | diff --git a/api-model-v1-45/docs/EndpointIPAMConfig.md b/api-model-v1-45/docs/EndpointIPAMConfig.md index f3a57409..f12793e4 100644 --- a/api-model-v1-45/docs/EndpointIPAMConfig.md +++ b/api-model-v1-45/docs/EndpointIPAMConfig.md @@ -2,11 +2,11 @@ # EndpointIPAMConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipv4Address** | **kotlin.String** | | [optional] -**ipv6Address** | **kotlin.String** | | [optional] -**linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | +| **linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/EndpointPortConfig.md b/api-model-v1-45/docs/EndpointPortConfig.md index c37f35dd..6dc393a5 100644 --- a/api-model-v1-45/docs/EndpointPortConfig.md +++ b/api-model-v1-45/docs/EndpointPortConfig.md @@ -2,27 +2,27 @@ # EndpointPortConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**protocol** | [**inline**](#Protocol) | | [optional] -**targetPort** | **kotlin.Int** | The port inside the container. | [optional] -**publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] -**publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **protocol** | [**inline**](#Protocol) | | [optional] | +| **targetPort** | **kotlin.Int** | The port inside the container. | [optional] | +| **publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] | +| **publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] | ## Enum: Protocol -Name | Value ----- | ----- -protocol | tcp, udp, sctp +| Name | Value | +| ---- | ----- | +| protocol | tcp, udp, sctp | ## Enum: PublishMode -Name | Value ----- | ----- -publishMode | ingress, host +| Name | Value | +| ---- | ----- | +| publishMode | ingress, host | diff --git a/api-model-v1-45/docs/EndpointSettings.md b/api-model-v1-45/docs/EndpointSettings.md index f971fc56..f6968796 100644 --- a/api-model-v1-45/docs/EndpointSettings.md +++ b/api-model-v1-45/docs/EndpointSettings.md @@ -2,22 +2,22 @@ # EndpointSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] -**links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] -**aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] -**networkID** | **kotlin.String** | Unique ID of the network. | [optional] -**endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] -**gateway** | **kotlin.String** | Gateway address for this network. | [optional] -**ipAddress** | **kotlin.String** | IPv4 address. | [optional] -**ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] -**ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] -**globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] -**globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] -**dnSNames** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **networkID** | **kotlin.String** | Unique ID of the network. | [optional] | +| **endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] | +| **gateway** | **kotlin.String** | Gateway address for this network. | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address. | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **dnSNames** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] | diff --git a/api-model-v1-45/docs/EndpointSpec.md b/api-model-v1-45/docs/EndpointSpec.md index 2e25afc1..9b02a1e3 100644 --- a/api-model-v1-45/docs/EndpointSpec.md +++ b/api-model-v1-45/docs/EndpointSpec.md @@ -2,17 +2,17 @@ # EndpointSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] | ## Enum: Mode -Name | Value ----- | ----- -mode | vip, dnsrr +| Name | Value | +| ---- | ----- | +| mode | vip, dnsrr | diff --git a/api-model-v1-45/docs/EngineDescription.md b/api-model-v1-45/docs/EngineDescription.md index 07445e46..c9abe8ae 100644 --- a/api-model-v1-45/docs/EngineDescription.md +++ b/api-model-v1-45/docs/EngineDescription.md @@ -2,11 +2,11 @@ # EngineDescription ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**engineVersion** | **kotlin.String** | | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] -**plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **engineVersion** | **kotlin.String** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] | diff --git a/api-model-v1-45/docs/EngineDescriptionPluginsInner.md b/api-model-v1-45/docs/EngineDescriptionPluginsInner.md index b2a8035c..53229a1d 100644 --- a/api-model-v1-45/docs/EngineDescriptionPluginsInner.md +++ b/api-model-v1-45/docs/EngineDescriptionPluginsInner.md @@ -2,10 +2,10 @@ # EngineDescriptionPluginsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/ErrorDetail.md b/api-model-v1-45/docs/ErrorDetail.md index c6d3457d..d909c08f 100644 --- a/api-model-v1-45/docs/ErrorDetail.md +++ b/api-model-v1-45/docs/ErrorDetail.md @@ -2,10 +2,10 @@ # ErrorDetail ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **kotlin.Int** | | [optional] -**message** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **code** | **kotlin.Int** | | [optional] | +| **message** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/ErrorResponse.md b/api-model-v1-45/docs/ErrorResponse.md index 302e2626..24722b5a 100644 --- a/api-model-v1-45/docs/ErrorResponse.md +++ b/api-model-v1-45/docs/ErrorResponse.md @@ -2,9 +2,9 @@ # ErrorResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **kotlin.String** | The error message. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | The error message. | | diff --git a/api-model-v1-45/docs/EventActor.md b/api-model-v1-45/docs/EventActor.md index 24e06ef9..62eadd88 100644 --- a/api-model-v1-45/docs/EventActor.md +++ b/api-model-v1-45/docs/EventActor.md @@ -2,10 +2,10 @@ # EventActor ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the object emitting the event | [optional] -**attributes** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the object emitting the event | [optional] | +| **attributes** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] | diff --git a/api-model-v1-45/docs/EventMessage.md b/api-model-v1-45/docs/EventMessage.md index 15c6cd6c..30e7daf3 100644 --- a/api-model-v1-45/docs/EventMessage.md +++ b/api-model-v1-45/docs/EventMessage.md @@ -2,28 +2,28 @@ # EventMessage ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | The type of object emitting the event | [optional] -**action** | **kotlin.String** | The type of event | [optional] -**actor** | [**EventActor**](EventActor.md) | | [optional] -**scope** | [**inline**](#Scope) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional] -**time** | **kotlin.Long** | Timestamp of event | [optional] -**timeNano** | **kotlin.Long** | Timestamp of event, with nanosecond accuracy | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The type of object emitting the event | [optional] | +| **action** | **kotlin.String** | The type of event | [optional] | +| **actor** | [**EventActor**](EventActor.md) | | [optional] | +| **scope** | [**inline**](#Scope) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional] | +| **time** | **kotlin.Long** | Timestamp of event | [optional] | +| **timeNano** | **kotlin.Long** | Timestamp of event, with nanosecond accuracy | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | builder, config, container, daemon, image, network, node, plugin, secret, service, volume +| Name | Value | +| ---- | ----- | +| type | builder, config, container, daemon, image, network, node, plugin, secret, service, volume | ## Enum: scope -Name | Value ----- | ----- -scope | local, swarm +| Name | Value | +| ---- | ----- | +| scope | local, swarm | diff --git a/api-model-v1-45/docs/ExecConfig.md b/api-model-v1-45/docs/ExecConfig.md index b505238e..29f9dea7 100644 --- a/api-model-v1-45/docs/ExecConfig.md +++ b/api-model-v1-45/docs/ExecConfig.md @@ -2,19 +2,19 @@ # ExecConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attachStdin** | **kotlin.Boolean** | Attach to `stdin` of the exec command. | [optional] -**attachStdout** | **kotlin.Boolean** | Attach to `stdout` of the exec command. | [optional] -**attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] -**detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] -**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] -**cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run, as a string or array of strings. | [optional] -**privileged** | **kotlin.Boolean** | Runs the exec process with extended privileges. | [optional] -**user** | **kotlin.String** | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional] -**workingDir** | **kotlin.String** | The working directory for the exec process inside the container. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **attachStdin** | **kotlin.Boolean** | Attach to `stdin` of the exec command. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Attach to `stdout` of the exec command. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run, as a string or array of strings. | [optional] | +| **privileged** | **kotlin.Boolean** | Runs the exec process with extended privileges. | [optional] | +| **user** | **kotlin.String** | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for the exec process inside the container. | [optional] | diff --git a/api-model-v1-45/docs/ExecInspectResponse.md b/api-model-v1-45/docs/ExecInspectResponse.md index 2d5c4658..17dac875 100644 --- a/api-model-v1-45/docs/ExecInspectResponse.md +++ b/api-model-v1-45/docs/ExecInspectResponse.md @@ -2,19 +2,19 @@ # ExecInspectResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**canRemove** | **kotlin.Boolean** | | [optional] -**detachKeys** | **kotlin.String** | | [optional] -**ID** | **kotlin.String** | | [optional] -**running** | **kotlin.Boolean** | | [optional] -**exitCode** | **kotlin.Int** | | [optional] -**processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] -**openStdin** | **kotlin.Boolean** | | [optional] -**openStderr** | **kotlin.Boolean** | | [optional] -**openStdout** | **kotlin.Boolean** | | [optional] -**containerID** | **kotlin.String** | | [optional] -**pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **canRemove** | **kotlin.Boolean** | | [optional] | +| **detachKeys** | **kotlin.String** | | [optional] | +| **ID** | **kotlin.String** | | [optional] | +| **running** | **kotlin.Boolean** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | +| **processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] | +| **openStdin** | **kotlin.Boolean** | | [optional] | +| **openStderr** | **kotlin.Boolean** | | [optional] | +| **openStdout** | **kotlin.Boolean** | | [optional] | +| **containerID** | **kotlin.String** | | [optional] | +| **pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] | diff --git a/api-model-v1-45/docs/ExecStartConfig.md b/api-model-v1-45/docs/ExecStartConfig.md index 11b32c82..8553f097 100644 --- a/api-model-v1-45/docs/ExecStartConfig.md +++ b/api-model-v1-45/docs/ExecStartConfig.md @@ -2,11 +2,11 @@ # ExecStartConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detach** | **kotlin.Boolean** | Detach from the command. | [optional] -**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **detach** | **kotlin.Boolean** | Detach from the command. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | diff --git a/api-model-v1-45/docs/FilesystemChange.md b/api-model-v1-45/docs/FilesystemChange.md index 0dce49dc..8354bea7 100644 --- a/api-model-v1-45/docs/FilesystemChange.md +++ b/api-model-v1-45/docs/FilesystemChange.md @@ -2,10 +2,10 @@ # FilesystemChange ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Path to file or directory that has changed. | -**kind** | [**ChangeType**](ChangeType.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Path to file or directory that has changed. | | +| **kind** | [**ChangeType**](ChangeType.md) | | | diff --git a/api-model-v1-45/docs/GenericResourcesInner.md b/api-model-v1-45/docs/GenericResourcesInner.md index 7e222a3e..0019d861 100644 --- a/api-model-v1-45/docs/GenericResourcesInner.md +++ b/api-model-v1-45/docs/GenericResourcesInner.md @@ -2,10 +2,10 @@ # GenericResourcesInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] -**discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] | +| **discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/GenericResourcesInnerDiscreteResourceSpec.md b/api-model-v1-45/docs/GenericResourcesInnerDiscreteResourceSpec.md index d19edea6..0b8faebe 100644 --- a/api-model-v1-45/docs/GenericResourcesInnerDiscreteResourceSpec.md +++ b/api-model-v1-45/docs/GenericResourcesInnerDiscreteResourceSpec.md @@ -2,10 +2,10 @@ # GenericResourcesInnerDiscreteResourceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kind** | **kotlin.String** | | [optional] -**`value`** | **kotlin.Long** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.Long** | | [optional] | diff --git a/api-model-v1-45/docs/GenericResourcesInnerNamedResourceSpec.md b/api-model-v1-45/docs/GenericResourcesInnerNamedResourceSpec.md index 75459921..0f5ec50d 100644 --- a/api-model-v1-45/docs/GenericResourcesInnerNamedResourceSpec.md +++ b/api-model-v1-45/docs/GenericResourcesInnerNamedResourceSpec.md @@ -2,10 +2,10 @@ # GenericResourcesInnerNamedResourceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kind** | **kotlin.String** | | [optional] -**`value`** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/GraphDriverData.md b/api-model-v1-45/docs/GraphDriverData.md index fe55e829..448e627c 100644 --- a/api-model-v1-45/docs/GraphDriverData.md +++ b/api-model-v1-45/docs/GraphDriverData.md @@ -2,10 +2,10 @@ # GraphDriverData ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the storage driver. | -**`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the storage driver. | | +| **`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] | diff --git a/api-model-v1-45/docs/Health.md b/api-model-v1-45/docs/Health.md index ea9667ac..e888268e 100644 --- a/api-model-v1-45/docs/Health.md +++ b/api-model-v1-45/docs/Health.md @@ -2,18 +2,18 @@ # Health ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] -**failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] -**log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] | +| **failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] | +| **log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] | ## Enum: Status -Name | Value ----- | ----- -status | none, starting, healthy, unhealthy +| Name | Value | +| ---- | ----- | +| status | none, starting, healthy, unhealthy | diff --git a/api-model-v1-45/docs/HealthConfig.md b/api-model-v1-45/docs/HealthConfig.md index 64bb021d..a6d4e19c 100644 --- a/api-model-v1-45/docs/HealthConfig.md +++ b/api-model-v1-45/docs/HealthConfig.md @@ -2,14 +2,14 @@ # HealthConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] -**interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] -**startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] -**startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] | +| **interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] | +| **startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | diff --git a/api-model-v1-45/docs/HealthcheckResult.md b/api-model-v1-45/docs/HealthcheckResult.md index 1d5a3cf4..1f0ab025 100644 --- a/api-model-v1-45/docs/HealthcheckResult.md +++ b/api-model-v1-45/docs/HealthcheckResult.md @@ -2,12 +2,12 @@ # HealthcheckResult ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] -**output** | **kotlin.String** | Output from last check | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] | +| **output** | **kotlin.String** | Output from last check | [optional] | diff --git a/api-model-v1-45/docs/HistoryResponseItem.md b/api-model-v1-45/docs/HistoryResponseItem.md index 20db3fff..dbbce217 100644 --- a/api-model-v1-45/docs/HistoryResponseItem.md +++ b/api-model-v1-45/docs/HistoryResponseItem.md @@ -2,14 +2,14 @@ # HistoryResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | | -**created** | **kotlin.Long** | | -**createdBy** | **kotlin.String** | | -**tags** | **kotlin.collections.MutableList<kotlin.String>** | | -**propertySize** | **kotlin.Long** | | -**comment** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | | +| **created** | **kotlin.Long** | | | +| **createdBy** | **kotlin.String** | | | +| **tags** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **propertySize** | **kotlin.Long** | | | +| **comment** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/HostConfig.md b/api-model-v1-45/docs/HostConfig.md index cc537e23..88bdce08 100644 --- a/api-model-v1-45/docs/HostConfig.md +++ b/api-model-v1-45/docs/HostConfig.md @@ -2,92 +2,92 @@ # HostConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] -**binds** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] -**containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] -**logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] -**networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] -**portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] -**restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] -**autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] -**volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] -**volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] -**mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] -**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] -**annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] -**capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] -**capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] -**cgroupnsMode** | [**inline**](#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. | [optional] -**dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] -**dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] -**dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] -**extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] -**groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] -**ipcMode** | **kotlin.String** | 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:<name|id>\"`: 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. | [optional] -**cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] -**links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] -**oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] -**pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] -**privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] -**publishAllPorts** | **kotlin.Boolean** | 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`. | [optional] -**readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] -**securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] -**storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] -**tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | 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\" } ``` | [optional] -**utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] -**usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] -**shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] -**sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [optional] -**runtime** | **kotlin.String** | Runtime to use with this container. | [optional] -**isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] -**maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] -**readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **binds** | **kotlin.collections.MutableList<kotlin.String>** | 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`. | [optional] | +| **containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] | +| **logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] | +| **networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] | +| **portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | +| **autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] | +| **volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] | +| **volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] | +| **capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] | +| **capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] | +| **cgroupnsMode** | [**inline**](#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. | [optional] | +| **dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] | +| **dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] | +| **dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] | +| **extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] | +| **groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **ipcMode** | **kotlin.String** | 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:<name|id>\"`: 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. | [optional] | +| **cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] | +| **oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] | +| **pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] | +| **privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] | +| **publishAllPorts** | **kotlin.Boolean** | 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`. | [optional] | +| **readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] | +| **storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] | +| **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | 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\" } ``` | [optional] | +| **utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] | +| **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] | +| **shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [optional] | +| **runtime** | **kotlin.String** | Runtime to use with this container. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] | +| **maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] | +| **readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] | ## Enum: CgroupnsMode -Name | Value ----- | ----- -cgroupnsMode | private, host +| Name | Value | +| ---- | ----- | +| cgroupnsMode | private, host | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, process, hyperv +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv | diff --git a/api-model-v1-45/docs/HostConfigAllOfLogConfig.md b/api-model-v1-45/docs/HostConfigAllOfLogConfig.md index c267c287..9b4d0b20 100644 --- a/api-model-v1-45/docs/HostConfigAllOfLogConfig.md +++ b/api-model-v1-45/docs/HostConfigAllOfLogConfig.md @@ -2,17 +2,17 @@ # HostConfigAllOfLogConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | | [optional] -**config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | | [optional] | +| **config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none +| Name | Value | +| ---- | ----- | +| type | json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none | diff --git a/api-model-v1-45/docs/IPAM.md b/api-model-v1-45/docs/IPAM.md index a26095dd..0dcc133a 100644 --- a/api-model-v1-45/docs/IPAM.md +++ b/api-model-v1-45/docs/IPAM.md @@ -2,11 +2,11 @@ # IPAM ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] -**config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] | +| **config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] | diff --git a/api-model-v1-45/docs/IPAMConfig.md b/api-model-v1-45/docs/IPAMConfig.md index 23ac27ae..f667c688 100644 --- a/api-model-v1-45/docs/IPAMConfig.md +++ b/api-model-v1-45/docs/IPAMConfig.md @@ -2,12 +2,12 @@ # IPAMConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subnet** | **kotlin.String** | | [optional] -**ipRange** | **kotlin.String** | | [optional] -**gateway** | **kotlin.String** | | [optional] -**auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subnet** | **kotlin.String** | | [optional] | +| **ipRange** | **kotlin.String** | | [optional] | +| **gateway** | **kotlin.String** | | [optional] | +| **auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/IdResponse.md b/api-model-v1-45/docs/IdResponse.md index bd08f794..7f34c29a 100644 --- a/api-model-v1-45/docs/IdResponse.md +++ b/api-model-v1-45/docs/IdResponse.md @@ -2,9 +2,9 @@ # IdResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The id of the newly created object. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The id of the newly created object. | | diff --git a/api-model-v1-45/docs/ImageDeleteResponseItem.md b/api-model-v1-45/docs/ImageDeleteResponseItem.md index 55e813aa..a5ea281f 100644 --- a/api-model-v1-45/docs/ImageDeleteResponseItem.md +++ b/api-model-v1-45/docs/ImageDeleteResponseItem.md @@ -2,10 +2,10 @@ # ImageDeleteResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] -**deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] | +| **deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] | diff --git a/api-model-v1-45/docs/ImageID.md b/api-model-v1-45/docs/ImageID.md index a093f834..6717d92f 100644 --- a/api-model-v1-45/docs/ImageID.md +++ b/api-model-v1-45/docs/ImageID.md @@ -2,9 +2,9 @@ # ImageID ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/ImageInspect.md b/api-model-v1-45/docs/ImageInspect.md index f04ba168..280f1c69 100644 --- a/api-model-v1-45/docs/ImageInspect.md +++ b/api-model-v1-45/docs/ImageInspect.md @@ -2,28 +2,28 @@ # ImageInspect ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] -**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] -**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] -**parent** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional] -**comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] -**created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. | [optional] -**container** | **kotlin.String** | The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. | [optional] -**containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**dockerVersion** | **kotlin.String** | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional] -**author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] -**config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] -**architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] -**variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] -**os** | **kotlin.String** | Operating System the image is built to run on. | [optional] -**osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] -**propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] -**virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] -**graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] -**rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] -**metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **parent** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional] | +| **comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] | +| **created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. | [optional] | +| **container** | **kotlin.String** | The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. | [optional] | +| **containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **dockerVersion** | **kotlin.String** | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional] | +| **author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] | +| **variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] | +| **os** | **kotlin.String** | Operating System the image is built to run on. | [optional] | +| **osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] | +| **virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] | +| **rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] | +| **metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] | diff --git a/api-model-v1-45/docs/ImageInspectMetadata.md b/api-model-v1-45/docs/ImageInspectMetadata.md index eb610bd6..4a2386cd 100644 --- a/api-model-v1-45/docs/ImageInspectMetadata.md +++ b/api-model-v1-45/docs/ImageInspectMetadata.md @@ -2,9 +2,9 @@ # ImageInspectMetadata ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] | diff --git a/api-model-v1-45/docs/ImageInspectRootFS.md b/api-model-v1-45/docs/ImageInspectRootFS.md index 67b94d16..503e2a52 100644 --- a/api-model-v1-45/docs/ImageInspectRootFS.md +++ b/api-model-v1-45/docs/ImageInspectRootFS.md @@ -2,10 +2,10 @@ # ImageInspectRootFS ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | -**layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | +| **layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/ImagePruneResponse.md b/api-model-v1-45/docs/ImagePruneResponse.md index d041d483..79320b4a 100644 --- a/api-model-v1-45/docs/ImagePruneResponse.md +++ b/api-model-v1-45/docs/ImagePruneResponse.md @@ -2,10 +2,10 @@ # ImagePruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-45/docs/ImageSearchResponseItem.md b/api-model-v1-45/docs/ImageSearchResponseItem.md index 42c68124..0831f12b 100644 --- a/api-model-v1-45/docs/ImageSearchResponseItem.md +++ b/api-model-v1-45/docs/ImageSearchResponseItem.md @@ -2,13 +2,13 @@ # ImageSearchResponseItem ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **kotlin.String** | | [optional] -**official** | **kotlin.Boolean** | | [optional] -**automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always be \"false\". | [optional] -**name** | **kotlin.String** | | [optional] -**starCount** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | [optional] | +| **official** | **kotlin.Boolean** | | [optional] | +| **automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always be \"false\". | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **starCount** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/ImageSummary.md b/api-model-v1-45/docs/ImageSummary.md index 51573a1d..c26c83f9 100644 --- a/api-model-v1-45/docs/ImageSummary.md +++ b/api-model-v1-45/docs/ImageSummary.md @@ -2,18 +2,18 @@ # ImageSummary ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | -**parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | -**created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds sinds EPOCH). | -**propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | -**sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | -**containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. | -**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] -**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] -**virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | | +| **parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | | +| **created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds sinds EPOCH). | | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | | +| **sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | | +| **containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. | | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | diff --git a/api-model-v1-45/docs/IndexInfo.md b/api-model-v1-45/docs/IndexInfo.md index 7018edfd..6b714641 100644 --- a/api-model-v1-45/docs/IndexInfo.md +++ b/api-model-v1-45/docs/IndexInfo.md @@ -2,12 +2,12 @@ # IndexInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] -**mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] -**secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] -**official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] | +| **secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] | +| **official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] | diff --git a/api-model-v1-45/docs/JoinTokens.md b/api-model-v1-45/docs/JoinTokens.md index 3225a335..5055d1c0 100644 --- a/api-model-v1-45/docs/JoinTokens.md +++ b/api-model-v1-45/docs/JoinTokens.md @@ -2,10 +2,10 @@ # JoinTokens ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] -**manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] | +| **manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] | diff --git a/api-model-v1-45/docs/Limit.md b/api-model-v1-45/docs/Limit.md index 655aff6b..09c047eb 100644 --- a/api-model-v1-45/docs/Limit.md +++ b/api-model-v1-45/docs/Limit.md @@ -2,11 +2,11 @@ # Limit ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nanoCPUs** | **kotlin.Long** | | [optional] -**memoryBytes** | **kotlin.Long** | | [optional] -**pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] | diff --git a/api-model-v1-45/docs/ManagerStatus.md b/api-model-v1-45/docs/ManagerStatus.md index 93a37f68..bfaa004e 100644 --- a/api-model-v1-45/docs/ManagerStatus.md +++ b/api-model-v1-45/docs/ManagerStatus.md @@ -2,11 +2,11 @@ # ManagerStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**leader** | **kotlin.Boolean** | | [optional] -**reachability** | [**Reachability**](Reachability.md) | | [optional] -**addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **leader** | **kotlin.Boolean** | | [optional] | +| **reachability** | [**Reachability**](Reachability.md) | | [optional] | +| **addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] | diff --git a/api-model-v1-45/docs/Mount.md b/api-model-v1-45/docs/Mount.md index 1045b64a..53eaf65c 100644 --- a/api-model-v1-45/docs/Mount.md +++ b/api-model-v1-45/docs/Mount.md @@ -2,23 +2,23 @@ # Mount ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target** | **kotlin.String** | Container path. | [optional] -**source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] -**type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] -**readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] -**consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] -**bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] -**volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] -**tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | Container path. | [optional] | +| **source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] | +| **type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] | +| **readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] | +| **consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] | +| **bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] | +| **volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] | +| **tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | bind, volume, tmpfs, npipe, cluster +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | diff --git a/api-model-v1-45/docs/MountBindOptions.md b/api-model-v1-45/docs/MountBindOptions.md index 1a7357fd..8d7a584b 100644 --- a/api-model-v1-45/docs/MountBindOptions.md +++ b/api-model-v1-45/docs/MountBindOptions.md @@ -2,20 +2,20 @@ # MountBindOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] -**nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] -**createMountpoint** | **kotlin.Boolean** | Create mount point on host if missing | [optional] -**readOnlyNonRecursive** | **kotlin.Boolean** | Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to `true` in conjunction). Addded in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to `true` for clients on versions prior to v1.44. | [optional] -**readOnlyForceRecursive** | **kotlin.Boolean** | Raise an error if the mount cannot be made recursively read-only. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] | +| **nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] | +| **createMountpoint** | **kotlin.Boolean** | Create mount point on host if missing | [optional] | +| **readOnlyNonRecursive** | **kotlin.Boolean** | Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to `true` in conjunction). Addded in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to `true` for clients on versions prior to v1.44. | [optional] | +| **readOnlyForceRecursive** | **kotlin.Boolean** | Raise an error if the mount cannot be made recursively read-only. | [optional] | ## Enum: Propagation -Name | Value ----- | ----- -propagation | private, rprivate, shared, rshared, slave, rslave +| Name | Value | +| ---- | ----- | +| propagation | private, rprivate, shared, rshared, slave, rslave | diff --git a/api-model-v1-45/docs/MountPoint.md b/api-model-v1-45/docs/MountPoint.md index f1a52839..58fe87ce 100644 --- a/api-model-v1-45/docs/MountPoint.md +++ b/api-model-v1-45/docs/MountPoint.md @@ -2,23 +2,23 @@ # MountPoint ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] -**name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] -**source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] -**destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] -**driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] -**mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] -**RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] -**propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] | +| **name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] | +| **source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] | +| **destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] | +| **driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] | +| **mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] | +| **RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] | +| **propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | bind, volume, tmpfs, npipe, cluster +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | diff --git a/api-model-v1-45/docs/MountTmpfsOptions.md b/api-model-v1-45/docs/MountTmpfsOptions.md index 94a17779..47a839a1 100644 --- a/api-model-v1-45/docs/MountTmpfsOptions.md +++ b/api-model-v1-45/docs/MountTmpfsOptions.md @@ -2,10 +2,10 @@ # MountTmpfsOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] -**mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] | +| **mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] | diff --git a/api-model-v1-45/docs/MountVolumeOptions.md b/api-model-v1-45/docs/MountVolumeOptions.md index ff7ec783..44ad3ede 100644 --- a/api-model-v1-45/docs/MountVolumeOptions.md +++ b/api-model-v1-45/docs/MountVolumeOptions.md @@ -2,12 +2,12 @@ # MountVolumeOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] -**subpath** | **kotlin.String** | Source path inside the volume. Must be relative without any back traversals. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] | +| **subpath** | **kotlin.String** | Source path inside the volume. Must be relative without any back traversals. | [optional] | diff --git a/api-model-v1-45/docs/MountVolumeOptionsDriverConfig.md b/api-model-v1-45/docs/MountVolumeOptionsDriverConfig.md index 084ee2c5..3cb98230 100644 --- a/api-model-v1-45/docs/MountVolumeOptionsDriverConfig.md +++ b/api-model-v1-45/docs/MountVolumeOptionsDriverConfig.md @@ -2,10 +2,10 @@ # MountVolumeOptionsDriverConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] | diff --git a/api-model-v1-45/docs/Network.md b/api-model-v1-45/docs/Network.md index 1af62551..f72eea2b 100644 --- a/api-model-v1-45/docs/Network.md +++ b/api-model-v1-45/docs/Network.md @@ -2,21 +2,21 @@ # Network ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**id** | **kotlin.String** | | [optional] -**created** | **kotlin.String** | | [optional] -**scope** | **kotlin.String** | | [optional] -**driver** | **kotlin.String** | | [optional] -**enableIPv6** | **kotlin.Boolean** | | [optional] -**IPAM** | [**IPAM**](IPAM.md) | | [optional] -**`internal`** | **kotlin.Boolean** | | [optional] -**attachable** | **kotlin.Boolean** | | [optional] -**ingress** | **kotlin.Boolean** | | [optional] -**containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **id** | **kotlin.String** | | [optional] | +| **created** | **kotlin.String** | | [optional] | +| **scope** | **kotlin.String** | | [optional] | +| **driver** | **kotlin.String** | | [optional] | +| **enableIPv6** | **kotlin.Boolean** | | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | | [optional] | +| **attachable** | **kotlin.Boolean** | | [optional] | +| **ingress** | **kotlin.Boolean** | | [optional] | +| **containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/NetworkAttachmentConfig.md b/api-model-v1-45/docs/NetworkAttachmentConfig.md index 55eae4cb..3f9c3cc4 100644 --- a/api-model-v1-45/docs/NetworkAttachmentConfig.md +++ b/api-model-v1-45/docs/NetworkAttachmentConfig.md @@ -2,11 +2,11 @@ # NetworkAttachmentConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] -**aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] | diff --git a/api-model-v1-45/docs/NetworkConnectRequest.md b/api-model-v1-45/docs/NetworkConnectRequest.md index 04789a8b..ae2c9438 100644 --- a/api-model-v1-45/docs/NetworkConnectRequest.md +++ b/api-model-v1-45/docs/NetworkConnectRequest.md @@ -2,10 +2,10 @@ # NetworkConnectRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**container** | **kotlin.String** | The ID or name of the container to connect to the network. | [optional] -**endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **container** | **kotlin.String** | The ID or name of the container to connect to the network. | [optional] | +| **endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] | diff --git a/api-model-v1-45/docs/NetworkContainer.md b/api-model-v1-45/docs/NetworkContainer.md index cc9e9482..5da790f2 100644 --- a/api-model-v1-45/docs/NetworkContainer.md +++ b/api-model-v1-45/docs/NetworkContainer.md @@ -2,13 +2,13 @@ # NetworkContainer ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**endpointID** | **kotlin.String** | | [optional] -**macAddress** | **kotlin.String** | | [optional] -**ipv4Address** | **kotlin.String** | | [optional] -**ipv6Address** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **endpointID** | **kotlin.String** | | [optional] | +| **macAddress** | **kotlin.String** | | [optional] | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/NetworkCreateRequest.md b/api-model-v1-45/docs/NetworkCreateRequest.md index 9a43a103..a8c1b1c5 100644 --- a/api-model-v1-45/docs/NetworkCreateRequest.md +++ b/api-model-v1-45/docs/NetworkCreateRequest.md @@ -2,18 +2,18 @@ # NetworkCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The network's name. | -**checkDuplicate** | **kotlin.Boolean** | Deprecated: CheckDuplicate is now always enabled. | [optional] -**driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] -**`internal`** | **kotlin.Boolean** | Restrict external access to the network. | [optional] -**attachable** | **kotlin.Boolean** | Globally scoped network is manually attachable by regular containers from workers in swarm mode. | [optional] -**ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] -**IPAM** | [**IPAM**](IPAM.md) | | [optional] -**enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The network's name. | | +| **checkDuplicate** | **kotlin.Boolean** | Deprecated: CheckDuplicate is now always enabled. | [optional] | +| **driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] | +| **`internal`** | **kotlin.Boolean** | Restrict external access to the network. | [optional] | +| **attachable** | **kotlin.Boolean** | Globally scoped network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | diff --git a/api-model-v1-45/docs/NetworkCreateResponse.md b/api-model-v1-45/docs/NetworkCreateResponse.md index 4535ebc4..319cddb2 100644 --- a/api-model-v1-45/docs/NetworkCreateResponse.md +++ b/api-model-v1-45/docs/NetworkCreateResponse.md @@ -2,10 +2,10 @@ # NetworkCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **kotlin.String** | The ID of the created network. | [optional] -**warning** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created network. | [optional] | +| **warning** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/NetworkDisconnectRequest.md b/api-model-v1-45/docs/NetworkDisconnectRequest.md index 5adfb121..c5d297fd 100644 --- a/api-model-v1-45/docs/NetworkDisconnectRequest.md +++ b/api-model-v1-45/docs/NetworkDisconnectRequest.md @@ -2,10 +2,10 @@ # NetworkDisconnectRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**container** | **kotlin.String** | The ID or name of the container to disconnect from the network. | [optional] -**force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **container** | **kotlin.String** | The ID or name of the container to disconnect from the network. | [optional] | +| **force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] | diff --git a/api-model-v1-45/docs/NetworkPruneResponse.md b/api-model-v1-45/docs/NetworkPruneResponse.md index 3f4d1a9c..9458d15f 100644 --- a/api-model-v1-45/docs/NetworkPruneResponse.md +++ b/api-model-v1-45/docs/NetworkPruneResponse.md @@ -2,9 +2,9 @@ # NetworkPruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] | diff --git a/api-model-v1-45/docs/NetworkSettings.md b/api-model-v1-45/docs/NetworkSettings.md index 8a1b131c..405e34ae 100644 --- a/api-model-v1-45/docs/NetworkSettings.md +++ b/api-model-v1-45/docs/NetworkSettings.md @@ -2,26 +2,26 @@ # NetworkSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bridge** | **kotlin.String** | Name of the default bridge interface when dockerd's --bridge flag is set. | [optional] -**sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] -**hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release. | [optional] -**linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release. | [optional] -**linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release. | [optional] -**ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] -**sandboxKey** | **kotlin.String** | SandboxKey is the full path of the netns handle | [optional] -**secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] -**secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] -**endpointID** | **kotlin.String** | EndpointID uniquely represents a service endpoint in a Sandbox. <p><br /></p> > **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 | [optional] -**gateway** | **kotlin.String** | Gateway address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**globalIPv6Address** | **kotlin.String** | Global IPv6 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**globalIPv6PrefixLen** | **kotlin.Int** | Mask length of the global IPv6 address. <p><br /></p> > **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 | [optional] -**ipAddress** | **kotlin.String** | IPv4 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. <p><br /></p> > **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 | [optional] -**ipv6Gateway** | **kotlin.String** | IPv6 gateway address for this network. <p><br /></p> > **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 | [optional] -**macAddress** | **kotlin.String** | MAC address for the container on the default \"bridge\" network. <p><br /></p> > **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 | [optional] -**networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **bridge** | **kotlin.String** | Name of the default bridge interface when dockerd's --bridge flag is set. | [optional] | +| **sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] | +| **hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **sandboxKey** | **kotlin.String** | SandboxKey is the full path of the netns handle | [optional] | +| **secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **endpointID** | **kotlin.String** | EndpointID uniquely represents a service endpoint in a Sandbox. <p><br /></p> > **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 | [optional] | +| **gateway** | **kotlin.String** | Gateway address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Int** | Mask length of the global IPv6 address. <p><br /></p> > **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 | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address for the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. <p><br /></p> > **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 | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address for this network. <p><br /></p> > **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 | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the container on the default \"bridge\" network. <p><br /></p> > **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 | [optional] | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] | diff --git a/api-model-v1-45/docs/NetworkingConfig.md b/api-model-v1-45/docs/NetworkingConfig.md index a6869a77..72814533 100644 --- a/api-model-v1-45/docs/NetworkingConfig.md +++ b/api-model-v1-45/docs/NetworkingConfig.md @@ -2,9 +2,9 @@ # NetworkingConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] | diff --git a/api-model-v1-45/docs/Node.md b/api-model-v1-45/docs/Node.md index b66079d4..8c180d58 100644 --- a/api-model-v1-45/docs/Node.md +++ b/api-model-v1-45/docs/Node.md @@ -2,16 +2,16 @@ # Node ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**NodeSpec**](NodeSpec.md) | | [optional] -**description** | [**NodeDescription**](NodeDescription.md) | | [optional] -**status** | [**NodeStatus**](NodeStatus.md) | | [optional] -**managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**NodeSpec**](NodeSpec.md) | | [optional] | +| **description** | [**NodeDescription**](NodeDescription.md) | | [optional] | +| **status** | [**NodeStatus**](NodeStatus.md) | | [optional] | +| **managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] | diff --git a/api-model-v1-45/docs/NodeDescription.md b/api-model-v1-45/docs/NodeDescription.md index 4a5dc851..9f9e1538 100644 --- a/api-model-v1-45/docs/NodeDescription.md +++ b/api-model-v1-45/docs/NodeDescription.md @@ -2,13 +2,13 @@ # NodeDescription ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostname** | **kotlin.String** | | [optional] -**platform** | [**Platform**](Platform.md) | | [optional] -**resources** | [**ResourceObject**](ResourceObject.md) | | [optional] -**engine** | [**EngineDescription**](EngineDescription.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | | [optional] | +| **platform** | [**Platform**](Platform.md) | | [optional] | +| **resources** | [**ResourceObject**](ResourceObject.md) | | [optional] | +| **engine** | [**EngineDescription**](EngineDescription.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | diff --git a/api-model-v1-45/docs/NodeSpec.md b/api-model-v1-45/docs/NodeSpec.md index 20f108e2..c4bf3121 100644 --- a/api-model-v1-45/docs/NodeSpec.md +++ b/api-model-v1-45/docs/NodeSpec.md @@ -2,26 +2,26 @@ # NodeSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name for the node. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**role** | [**inline**](#Role) | Role of the node. | [optional] -**availability** | [**inline**](#Availability) | Availability of the node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name for the node. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **role** | [**inline**](#Role) | Role of the node. | [optional] | +| **availability** | [**inline**](#Availability) | Availability of the node. | [optional] | ## Enum: Role -Name | Value ----- | ----- -role | worker, manager +| Name | Value | +| ---- | ----- | +| role | worker, manager | ## Enum: Availability -Name | Value ----- | ----- -availability | active, pause, drain +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | diff --git a/api-model-v1-45/docs/NodeStatus.md b/api-model-v1-45/docs/NodeStatus.md index 86eaa2d9..426c3f2d 100644 --- a/api-model-v1-45/docs/NodeStatus.md +++ b/api-model-v1-45/docs/NodeStatus.md @@ -2,11 +2,11 @@ # NodeStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**state** | [**NodeState**](NodeState.md) | | [optional] -**message** | **kotlin.String** | | [optional] -**addr** | **kotlin.String** | IP address of the node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**NodeState**](NodeState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | IP address of the node. | [optional] | diff --git a/api-model-v1-45/docs/OCIDescriptor.md b/api-model-v1-45/docs/OCIDescriptor.md index f31d04e6..76474758 100644 --- a/api-model-v1-45/docs/OCIDescriptor.md +++ b/api-model-v1-45/docs/OCIDescriptor.md @@ -2,11 +2,11 @@ # OCIDescriptor ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] -**digest** | **kotlin.String** | The digest of the targeted content. | [optional] -**propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] | +| **digest** | **kotlin.String** | The digest of the targeted content. | [optional] | +| **propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] | diff --git a/api-model-v1-45/docs/OCIPlatform.md b/api-model-v1-45/docs/OCIPlatform.md index 76d3ec98..606c4124 100644 --- a/api-model-v1-45/docs/OCIPlatform.md +++ b/api-model-v1-45/docs/OCIPlatform.md @@ -2,13 +2,13 @@ # OCIPlatform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] -**os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] -**osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] -**osFeatures** | **kotlin.collections.MutableList<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] -**variant** | **kotlin.String** | Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] | +| **os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] | +| **osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] | +| **osFeatures** | **kotlin.collections.MutableList<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] | +| **variant** | **kotlin.String** | Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. | [optional] | diff --git a/api-model-v1-45/docs/ObjectVersion.md b/api-model-v1-45/docs/ObjectVersion.md index 63306ac0..a2584d76 100644 --- a/api-model-v1-45/docs/ObjectVersion.md +++ b/api-model-v1-45/docs/ObjectVersion.md @@ -2,9 +2,9 @@ # ObjectVersion ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **index** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/PeerNode.md b/api-model-v1-45/docs/PeerNode.md index 986599f9..e3954b83 100644 --- a/api-model-v1-45/docs/PeerNode.md +++ b/api-model-v1-45/docs/PeerNode.md @@ -2,10 +2,10 @@ # PeerNode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] -**addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] | diff --git a/api-model-v1-45/docs/Platform.md b/api-model-v1-45/docs/Platform.md index 7a876750..d8a705d2 100644 --- a/api-model-v1-45/docs/Platform.md +++ b/api-model-v1-45/docs/Platform.md @@ -2,10 +2,10 @@ # Platform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] -**OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] | +| **OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] | diff --git a/api-model-v1-45/docs/Plugin.md b/api-model-v1-45/docs/Plugin.md index 761860d1..cd67ed8a 100644 --- a/api-model-v1-45/docs/Plugin.md +++ b/api-model-v1-45/docs/Plugin.md @@ -2,14 +2,14 @@ # Plugin ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | -**settings** | [**PluginSettings**](PluginSettings.md) | | -**config** | [**PluginConfig**](PluginConfig.md) | | -**id** | **kotlin.String** | | [optional] -**pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | | +| **settings** | [**PluginSettings**](PluginSettings.md) | | | +| **config** | [**PluginConfig**](PluginConfig.md) | | | +| **id** | **kotlin.String** | | [optional] | +| **pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] | diff --git a/api-model-v1-45/docs/PluginConfig.md b/api-model-v1-45/docs/PluginConfig.md index b1c55fba..064225fb 100644 --- a/api-model-v1-45/docs/PluginConfig.md +++ b/api-model-v1-45/docs/PluginConfig.md @@ -2,24 +2,24 @@ # PluginConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **kotlin.String** | | -**documentation** | **kotlin.String** | | -**`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | -**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | -**workDir** | **kotlin.String** | | -**network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | -**linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | -**propagatedMount** | **kotlin.String** | | -**ipcHost** | **kotlin.Boolean** | | -**pidHost** | **kotlin.Boolean** | | -**mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | -**env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | -**args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | -**dockerVersion** | **kotlin.String** | Docker Version used to create the plugin | [optional] -**user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] -**rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | | +| **documentation** | **kotlin.String** | | | +| **`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **workDir** | **kotlin.String** | | | +| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | | +| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | | +| **propagatedMount** | **kotlin.String** | | | +| **ipcHost** | **kotlin.Boolean** | | | +| **pidHost** | **kotlin.Boolean** | | | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | | +| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | | +| **dockerVersion** | **kotlin.String** | Docker Version used to create the plugin | [optional] | +| **user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] | +| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] | diff --git a/api-model-v1-45/docs/PluginConfigArgs.md b/api-model-v1-45/docs/PluginConfigArgs.md index d1c4ec86..77ce533c 100644 --- a/api-model-v1-45/docs/PluginConfigArgs.md +++ b/api-model-v1-45/docs/PluginConfigArgs.md @@ -2,12 +2,12 @@ # PluginConfigArgs ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | | diff --git a/api-model-v1-45/docs/PluginConfigInterface.md b/api-model-v1-45/docs/PluginConfigInterface.md index d9fad568..2c930f60 100644 --- a/api-model-v1-45/docs/PluginConfigInterface.md +++ b/api-model-v1-45/docs/PluginConfigInterface.md @@ -2,18 +2,18 @@ # PluginConfigInterface ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | -**socket** | **kotlin.String** | | -**protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | | +| **socket** | **kotlin.String** | | | +| **protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] | ## Enum: ProtocolScheme -Name | Value ----- | ----- -protocolScheme | , moby.plugins.http/v1 +| Name | Value | +| ---- | ----- | +| protocolScheme | , moby.plugins.http/v1 | diff --git a/api-model-v1-45/docs/PluginConfigLinux.md b/api-model-v1-45/docs/PluginConfigLinux.md index a343e2ad..f3ca6ce8 100644 --- a/api-model-v1-45/docs/PluginConfigLinux.md +++ b/api-model-v1-45/docs/PluginConfigLinux.md @@ -2,11 +2,11 @@ # PluginConfigLinux ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | -**allowAllDevices** | **kotlin.Boolean** | | -**devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **allowAllDevices** | **kotlin.Boolean** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | diff --git a/api-model-v1-45/docs/PluginConfigNetwork.md b/api-model-v1-45/docs/PluginConfigNetwork.md index dae618b3..4b0e40e5 100644 --- a/api-model-v1-45/docs/PluginConfigNetwork.md +++ b/api-model-v1-45/docs/PluginConfigNetwork.md @@ -2,9 +2,9 @@ # PluginConfigNetwork ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/PluginConfigRootfs.md b/api-model-v1-45/docs/PluginConfigRootfs.md index b216d3e8..4f17530b 100644 --- a/api-model-v1-45/docs/PluginConfigRootfs.md +++ b/api-model-v1-45/docs/PluginConfigRootfs.md @@ -2,10 +2,10 @@ # PluginConfigRootfs ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **kotlin.String** | | [optional] -**diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/PluginConfigUser.md b/api-model-v1-45/docs/PluginConfigUser.md index 81aa9259..1d3973c2 100644 --- a/api-model-v1-45/docs/PluginConfigUser.md +++ b/api-model-v1-45/docs/PluginConfigUser.md @@ -2,10 +2,10 @@ # PluginConfigUser ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UID** | **kotlin.Int** | | [optional] -**GID** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **UID** | **kotlin.Int** | | [optional] | +| **GID** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/PluginDevice.md b/api-model-v1-45/docs/PluginDevice.md index 55c5bc33..9ca354a5 100644 --- a/api-model-v1-45/docs/PluginDevice.md +++ b/api-model-v1-45/docs/PluginDevice.md @@ -2,12 +2,12 @@ # PluginDevice ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**path** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **path** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/PluginEnv.md b/api-model-v1-45/docs/PluginEnv.md index 49ccca71..ff31d08b 100644 --- a/api-model-v1-45/docs/PluginEnv.md +++ b/api-model-v1-45/docs/PluginEnv.md @@ -2,12 +2,12 @@ # PluginEnv ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**`value`** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/PluginInterfaceType.md b/api-model-v1-45/docs/PluginInterfaceType.md index c0eb9f5c..de46fee9 100644 --- a/api-model-v1-45/docs/PluginInterfaceType.md +++ b/api-model-v1-45/docs/PluginInterfaceType.md @@ -2,11 +2,11 @@ # PluginInterfaceType ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**prefix** | **kotlin.String** | | -**capability** | **kotlin.String** | | -**version** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **prefix** | **kotlin.String** | | | +| **capability** | **kotlin.String** | | | +| **version** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/PluginMount.md b/api-model-v1-45/docs/PluginMount.md index c6dff2af..77eaf741 100644 --- a/api-model-v1-45/docs/PluginMount.md +++ b/api-model-v1-45/docs/PluginMount.md @@ -2,15 +2,15 @@ # PluginMount ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | -**description** | **kotlin.String** | | -**settable** | **kotlin.collections.MutableList<kotlin.String>** | | -**source** | **kotlin.String** | | -**destination** | **kotlin.String** | | -**type** | **kotlin.String** | | -**options** | **kotlin.collections.MutableList<kotlin.String>** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **source** | **kotlin.String** | | | +| **destination** | **kotlin.String** | | | +| **type** | **kotlin.String** | | | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | | | diff --git a/api-model-v1-45/docs/PluginPrivilege.md b/api-model-v1-45/docs/PluginPrivilege.md index 4e580989..5c384bb6 100644 --- a/api-model-v1-45/docs/PluginPrivilege.md +++ b/api-model-v1-45/docs/PluginPrivilege.md @@ -2,11 +2,11 @@ # PluginPrivilege ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**description** | **kotlin.String** | | [optional] -**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **description** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/PluginSettings.md b/api-model-v1-45/docs/PluginSettings.md index 8d1985c2..1797e9c5 100644 --- a/api-model-v1-45/docs/PluginSettings.md +++ b/api-model-v1-45/docs/PluginSettings.md @@ -2,12 +2,12 @@ # PluginSettings ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | -**env** | **kotlin.collections.MutableList<kotlin.String>** | | -**args** | **kotlin.collections.MutableList<kotlin.String>** | | -**devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | diff --git a/api-model-v1-45/docs/PluginsInfo.md b/api-model-v1-45/docs/PluginsInfo.md index 233e9342..6f726d26 100644 --- a/api-model-v1-45/docs/PluginsInfo.md +++ b/api-model-v1-45/docs/PluginsInfo.md @@ -2,12 +2,12 @@ # PluginsInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] -**network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] -**authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] -**log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] | +| **network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] | +| **authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] | +| **log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] | diff --git a/api-model-v1-45/docs/Port.md b/api-model-v1-45/docs/Port.md index bfc09156..5f73834c 100644 --- a/api-model-v1-45/docs/Port.md +++ b/api-model-v1-45/docs/Port.md @@ -2,19 +2,19 @@ # Port ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**privatePort** | **kotlin.Int** | Port on the container | -**type** | [**inline**](#Type) | | -**IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] -**publicPort** | **kotlin.Int** | Port exposed on the host | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privatePort** | **kotlin.Int** | Port on the container | | +| **type** | [**inline**](#Type) | | | +| **IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] | +| **publicPort** | **kotlin.Int** | Port exposed on the host | [optional] | ## Enum: Type -Name | Value ----- | ----- -type | tcp, udp, sctp +| Name | Value | +| ---- | ----- | +| type | tcp, udp, sctp | diff --git a/api-model-v1-45/docs/PortBinding.md b/api-model-v1-45/docs/PortBinding.md index 3a0978f1..0cf0dea5 100644 --- a/api-model-v1-45/docs/PortBinding.md +++ b/api-model-v1-45/docs/PortBinding.md @@ -2,10 +2,10 @@ # PortBinding ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] -**hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] | +| **hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] | diff --git a/api-model-v1-45/docs/PortStatus.md b/api-model-v1-45/docs/PortStatus.md index cbdeedc0..24def5e3 100644 --- a/api-model-v1-45/docs/PortStatus.md +++ b/api-model-v1-45/docs/PortStatus.md @@ -2,9 +2,9 @@ # PortStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | diff --git a/api-model-v1-45/docs/ProcessConfig.md b/api-model-v1-45/docs/ProcessConfig.md index 5ad4c154..921ea328 100644 --- a/api-model-v1-45/docs/ProcessConfig.md +++ b/api-model-v1-45/docs/ProcessConfig.md @@ -2,13 +2,13 @@ # ProcessConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**privileged** | **kotlin.Boolean** | | [optional] -**user** | **kotlin.String** | | [optional] -**tty** | **kotlin.Boolean** | | [optional] -**entrypoint** | **kotlin.String** | | [optional] -**arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privileged** | **kotlin.Boolean** | | [optional] | +| **user** | **kotlin.String** | | [optional] | +| **tty** | **kotlin.Boolean** | | [optional] | +| **entrypoint** | **kotlin.String** | | [optional] | +| **arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/ProgressDetail.md b/api-model-v1-45/docs/ProgressDetail.md index c70ad3b3..17d327a3 100644 --- a/api-model-v1-45/docs/ProgressDetail.md +++ b/api-model-v1-45/docs/ProgressDetail.md @@ -2,10 +2,10 @@ # ProgressDetail ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**current** | **kotlin.Int** | | [optional] -**total** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **current** | **kotlin.Int** | | [optional] | +| **total** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/PushImageInfo.md b/api-model-v1-45/docs/PushImageInfo.md index 5eddb6c0..35a5e13f 100644 --- a/api-model-v1-45/docs/PushImageInfo.md +++ b/api-model-v1-45/docs/PushImageInfo.md @@ -2,12 +2,12 @@ # PushImageInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **kotlin.String** | | [optional] -**status** | **kotlin.String** | | [optional] -**progress** | **kotlin.String** | | [optional] -**progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **error** | **kotlin.String** | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | diff --git a/api-model-v1-45/docs/RegistryServiceConfig.md b/api-model-v1-45/docs/RegistryServiceConfig.md index 052a1274..8359fbc9 100644 --- a/api-model-v1-45/docs/RegistryServiceConfig.md +++ b/api-model-v1-45/docs/RegistryServiceConfig.md @@ -2,13 +2,13 @@ # RegistryServiceConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allowNondistributableArtifactsCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**allowNondistributableArtifactsHostnames** | **kotlin.collections.MutableList<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] -**indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] -**mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **allowNondistributableArtifactsCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] | +| **allowNondistributableArtifactsHostnames** | **kotlin.collections.MutableList<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] | +| **insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] | +| **indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] | diff --git a/api-model-v1-45/docs/ResourceObject.md b/api-model-v1-45/docs/ResourceObject.md index 044d53a5..b4652bf8 100644 --- a/api-model-v1-45/docs/ResourceObject.md +++ b/api-model-v1-45/docs/ResourceObject.md @@ -2,11 +2,11 @@ # ResourceObject ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nanoCPUs** | **kotlin.Long** | | [optional] -**memoryBytes** | **kotlin.Long** | | [optional] -**genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | diff --git a/api-model-v1-45/docs/Resources.md b/api-model-v1-45/docs/Resources.md index f83e46c8..f18a199b 100644 --- a/api-model-v1-45/docs/Resources.md +++ b/api-model-v1-45/docs/Resources.md @@ -2,39 +2,39 @@ # Resources ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] -**memory** | **kotlin.Long** | Memory limit in bytes. | [optional] -**cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] -**blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] -**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] -**cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] -**cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] -**cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] -**cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] -**devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] -**kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] -**memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] -**memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] -**memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] -**nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] -**cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] -**ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] -**ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | diff --git a/api-model-v1-45/docs/ResourcesBlkioWeightDeviceInner.md b/api-model-v1-45/docs/ResourcesBlkioWeightDeviceInner.md index 2160bf09..8adad1d4 100644 --- a/api-model-v1-45/docs/ResourcesBlkioWeightDeviceInner.md +++ b/api-model-v1-45/docs/ResourcesBlkioWeightDeviceInner.md @@ -2,10 +2,10 @@ # ResourcesBlkioWeightDeviceInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | | [optional] -**weight** | **kotlin.Int** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | | [optional] | +| **weight** | **kotlin.Int** | | [optional] | diff --git a/api-model-v1-45/docs/ResourcesUlimitsInner.md b/api-model-v1-45/docs/ResourcesUlimitsInner.md index 312c7956..8ad484f1 100644 --- a/api-model-v1-45/docs/ResourcesUlimitsInner.md +++ b/api-model-v1-45/docs/ResourcesUlimitsInner.md @@ -2,11 +2,11 @@ # ResourcesUlimitsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of ulimit | [optional] -**soft** | **kotlin.Int** | Soft limit | [optional] -**hard** | **kotlin.Int** | Hard limit | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of ulimit | [optional] | +| **soft** | **kotlin.Int** | Soft limit | [optional] | +| **hard** | **kotlin.Int** | Hard limit | [optional] | diff --git a/api-model-v1-45/docs/RestartPolicy.md b/api-model-v1-45/docs/RestartPolicy.md index cea00dc6..09a0e982 100644 --- a/api-model-v1-45/docs/RestartPolicy.md +++ b/api-model-v1-45/docs/RestartPolicy.md @@ -2,17 +2,17 @@ # RestartPolicy ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**inline**](#Name) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] -**maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | [**inline**](#Name) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] | +| **maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] | ## Enum: Name -Name | Value ----- | ----- -name | , no, always, unless-stopped, on-failure +| Name | Value | +| ---- | ----- | +| name | , no, always, unless-stopped, on-failure | diff --git a/api-model-v1-45/docs/Runtime.md b/api-model-v1-45/docs/Runtime.md index 59775e1b..e244ad7c 100644 --- a/api-model-v1-45/docs/Runtime.md +++ b/api-model-v1-45/docs/Runtime.md @@ -2,11 +2,11 @@ # Runtime ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] -**runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] -**status** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] | +| **status** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | diff --git a/api-model-v1-45/docs/Secret.md b/api-model-v1-45/docs/Secret.md index 645fc011..9a87a568 100644 --- a/api-model-v1-45/docs/Secret.md +++ b/api-model-v1-45/docs/Secret.md @@ -2,13 +2,13 @@ # Secret ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**SecretSpec**](SecretSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**SecretSpec**](SecretSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/SecretCreateRequest.md b/api-model-v1-45/docs/SecretCreateRequest.md index 97257bdb..b445a37f 100644 --- a/api-model-v1-45/docs/SecretCreateRequest.md +++ b/api-model-v1-45/docs/SecretCreateRequest.md @@ -2,13 +2,13 @@ # SecretCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the secret. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] -**driver** | [**Driver**](Driver.md) | | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-45/docs/SecretSpec.md b/api-model-v1-45/docs/SecretSpec.md index 38118de3..539c6aad 100644 --- a/api-model-v1-45/docs/SecretSpec.md +++ b/api-model-v1-45/docs/SecretSpec.md @@ -2,13 +2,13 @@ # SecretSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | User-defined name of the secret. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] -**driver** | [**Driver**](Driver.md) | | [optional] -**templating** | [**Driver**](Driver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | diff --git a/api-model-v1-45/docs/Service.md b/api-model-v1-45/docs/Service.md index c49a4aeb..d2e0c3c9 100644 --- a/api-model-v1-45/docs/Service.md +++ b/api-model-v1-45/docs/Service.md @@ -2,17 +2,17 @@ # Service ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] -**endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] -**updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] -**serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] -**jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] | +| **endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] | +| **updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] | +| **serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] | +| **jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] | diff --git a/api-model-v1-45/docs/ServiceCreateRequest.md b/api-model-v1-45/docs/ServiceCreateRequest.md index 77f993f8..e13b9730 100644 --- a/api-model-v1-45/docs/ServiceCreateRequest.md +++ b/api-model-v1-45/docs/ServiceCreateRequest.md @@ -2,16 +2,16 @@ # ServiceCreateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/ServiceCreateResponse.md b/api-model-v1-45/docs/ServiceCreateResponse.md index 9b318737..bccceaa6 100644 --- a/api-model-v1-45/docs/ServiceCreateResponse.md +++ b/api-model-v1-45/docs/ServiceCreateResponse.md @@ -2,10 +2,10 @@ # ServiceCreateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the created service. | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the created service. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] | diff --git a/api-model-v1-45/docs/ServiceEndpoint.md b/api-model-v1-45/docs/ServiceEndpoint.md index b3e08c5d..e0f1c900 100644 --- a/api-model-v1-45/docs/ServiceEndpoint.md +++ b/api-model-v1-45/docs/ServiceEndpoint.md @@ -2,11 +2,11 @@ # ServiceEndpoint ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] -**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] -**virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | +| **virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] | diff --git a/api-model-v1-45/docs/ServiceEndpointVirtualIPsInner.md b/api-model-v1-45/docs/ServiceEndpointVirtualIPsInner.md index 52b7db86..f893c9c6 100644 --- a/api-model-v1-45/docs/ServiceEndpointVirtualIPsInner.md +++ b/api-model-v1-45/docs/ServiceEndpointVirtualIPsInner.md @@ -2,10 +2,10 @@ # ServiceEndpointVirtualIPsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**networkID** | **kotlin.String** | | [optional] -**addr** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkID** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | | [optional] | diff --git a/api-model-v1-45/docs/ServiceJobStatus.md b/api-model-v1-45/docs/ServiceJobStatus.md index 8ba99c0c..8227bff6 100644 --- a/api-model-v1-45/docs/ServiceJobStatus.md +++ b/api-model-v1-45/docs/ServiceJobStatus.md @@ -2,10 +2,10 @@ # ServiceJobStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] | diff --git a/api-model-v1-45/docs/ServiceServiceStatus.md b/api-model-v1-45/docs/ServiceServiceStatus.md index 5d1df316..79fd1de2 100644 --- a/api-model-v1-45/docs/ServiceServiceStatus.md +++ b/api-model-v1-45/docs/ServiceServiceStatus.md @@ -2,11 +2,11 @@ # ServiceServiceStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] -**desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] -**completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] | +| **desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] | +| **completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] | diff --git a/api-model-v1-45/docs/ServiceSpec.md b/api-model-v1-45/docs/ServiceSpec.md index 3fdae731..2c5c547c 100644 --- a/api-model-v1-45/docs/ServiceSpec.md +++ b/api-model-v1-45/docs/ServiceSpec.md @@ -2,16 +2,16 @@ # ServiceSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/ServiceSpecMode.md b/api-model-v1-45/docs/ServiceSpecMode.md index c74a2c35..7b9ddebd 100644 --- a/api-model-v1-45/docs/ServiceSpecMode.md +++ b/api-model-v1-45/docs/ServiceSpecMode.md @@ -2,12 +2,12 @@ # ServiceSpecMode ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] -**global** | [**kotlin.Any**](.md) | | [optional] -**replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] -**globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] | +| **global** | [**kotlin.Any**](.md) | | [optional] | +| **replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] | +| **globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] | diff --git a/api-model-v1-45/docs/ServiceSpecModeReplicated.md b/api-model-v1-45/docs/ServiceSpecModeReplicated.md index 721d67d6..9e2617c0 100644 --- a/api-model-v1-45/docs/ServiceSpecModeReplicated.md +++ b/api-model-v1-45/docs/ServiceSpecModeReplicated.md @@ -2,9 +2,9 @@ # ServiceSpecModeReplicated ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**replicas** | **kotlin.Long** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicas** | **kotlin.Long** | | [optional] | diff --git a/api-model-v1-45/docs/ServiceSpecModeReplicatedJob.md b/api-model-v1-45/docs/ServiceSpecModeReplicatedJob.md index 64cd1877..215cf92f 100644 --- a/api-model-v1-45/docs/ServiceSpecModeReplicatedJob.md +++ b/api-model-v1-45/docs/ServiceSpecModeReplicatedJob.md @@ -2,10 +2,10 @@ # ServiceSpecModeReplicatedJob ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] -**totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] | +| **totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] | diff --git a/api-model-v1-45/docs/ServiceSpecRollbackConfig.md b/api-model-v1-45/docs/ServiceSpecRollbackConfig.md index 4858c8ac..109ce61a 100644 --- a/api-model-v1-45/docs/ServiceSpecRollbackConfig.md +++ b/api-model-v1-45/docs/ServiceSpecRollbackConfig.md @@ -2,28 +2,28 @@ # ServiceSpecRollbackConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] -**delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] -**failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] -**monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] -**maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] -**order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | ## Enum: FailureAction -Name | Value ----- | ----- -failureAction | continue, pause +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause | ## Enum: Order -Name | Value ----- | ----- -order | stop-first, start-first +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | diff --git a/api-model-v1-45/docs/ServiceSpecUpdateConfig.md b/api-model-v1-45/docs/ServiceSpecUpdateConfig.md index 9a45b366..b8a267a7 100644 --- a/api-model-v1-45/docs/ServiceSpecUpdateConfig.md +++ b/api-model-v1-45/docs/ServiceSpecUpdateConfig.md @@ -2,28 +2,28 @@ # ServiceSpecUpdateConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] -**delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] -**failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] -**monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] -**maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] -**order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | ## Enum: FailureAction -Name | Value ----- | ----- -failureAction | continue, pause, rollback +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause, rollback | ## Enum: Order -Name | Value ----- | ----- -order | stop-first, start-first +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | diff --git a/api-model-v1-45/docs/ServiceUpdateRequest.md b/api-model-v1-45/docs/ServiceUpdateRequest.md index c6e90d14..17c4c804 100644 --- a/api-model-v1-45/docs/ServiceUpdateRequest.md +++ b/api-model-v1-45/docs/ServiceUpdateRequest.md @@ -2,16 +2,16 @@ # ServiceUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] -**mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] -**updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] -**rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] -**endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/ServiceUpdateResponse.md b/api-model-v1-45/docs/ServiceUpdateResponse.md index 6de72db5..d131f923 100644 --- a/api-model-v1-45/docs/ServiceUpdateResponse.md +++ b/api-model-v1-45/docs/ServiceUpdateResponse.md @@ -2,9 +2,9 @@ # ServiceUpdateResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] | diff --git a/api-model-v1-45/docs/ServiceUpdateStatus.md b/api-model-v1-45/docs/ServiceUpdateStatus.md index f6864e22..be528d9c 100644 --- a/api-model-v1-45/docs/ServiceUpdateStatus.md +++ b/api-model-v1-45/docs/ServiceUpdateStatus.md @@ -2,19 +2,19 @@ # ServiceUpdateStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**state** | [**inline**](#State) | | [optional] -**startedAt** | **kotlin.String** | | [optional] -**completedAt** | **kotlin.String** | | [optional] -**message** | **kotlin.String** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**inline**](#State) | | [optional] | +| **startedAt** | **kotlin.String** | | [optional] | +| **completedAt** | **kotlin.String** | | [optional] | +| **message** | **kotlin.String** | | [optional] | ## Enum: State -Name | Value ----- | ----- -state | updating, paused, completed +| Name | Value | +| ---- | ----- | +| state | updating, paused, completed | diff --git a/api-model-v1-45/docs/Swarm.md b/api-model-v1-45/docs/Swarm.md index b0eb5255..6c752000 100644 --- a/api-model-v1-45/docs/Swarm.md +++ b/api-model-v1-45/docs/Swarm.md @@ -2,19 +2,19 @@ # Swarm ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the swarm. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] -**tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] -**rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] -**joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] | diff --git a/api-model-v1-45/docs/SwarmInfo.md b/api-model-v1-45/docs/SwarmInfo.md index 9dea5c10..cb655c0b 100644 --- a/api-model-v1-45/docs/SwarmInfo.md +++ b/api-model-v1-45/docs/SwarmInfo.md @@ -2,17 +2,17 @@ # SwarmInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] -**nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] -**localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] -**controlAvailable** | **kotlin.Boolean** | | [optional] -**error** | **kotlin.String** | | [optional] -**remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] -**nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] -**managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] -**cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] | +| **localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] | +| **controlAvailable** | **kotlin.Boolean** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] | +| **nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] | +| **managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] | +| **cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] | diff --git a/api-model-v1-45/docs/SwarmInitRequest.md b/api-model-v1-45/docs/SwarmInitRequest.md index 9c3d9c68..f4503ae3 100644 --- a/api-model-v1-45/docs/SwarmInitRequest.md +++ b/api-model-v1-45/docs/SwarmInitRequest.md @@ -2,16 +2,16 @@ # SwarmInitRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. | [optional] -**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] -**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] -**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] -**defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] -**forceNewCluster** | **kotlin.Boolean** | Force creation of a new swarm. | [optional] -**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] -**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **listenAddr** | **kotlin.String** | Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. | [optional] | +| **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] | +| **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] | +| **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **forceNewCluster** | **kotlin.Boolean** | Force creation of a new swarm. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/SwarmJoinRequest.md b/api-model-v1-45/docs/SwarmJoinRequest.md index 5dd4fa1e..854e0fc2 100644 --- a/api-model-v1-45/docs/SwarmJoinRequest.md +++ b/api-model-v1-45/docs/SwarmJoinRequest.md @@ -2,13 +2,13 @@ # SwarmJoinRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] -**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] -**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] -**remoteAddrs** | **kotlin.collections.MutableList<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] -**joinToken** | **kotlin.String** | Secret token for joining this swarm. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] | +| **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] | +| **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] | +| **remoteAddrs** | **kotlin.collections.MutableList<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] | +| **joinToken** | **kotlin.String** | Secret token for joining this swarm. | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpec.md b/api-model-v1-45/docs/SwarmSpec.md index 5a6a4a9f..55042008 100644 --- a/api-model-v1-45/docs/SwarmSpec.md +++ b/api-model-v1-45/docs/SwarmSpec.md @@ -2,16 +2,16 @@ # SwarmSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the swarm. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] -**raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] -**dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] -**caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] -**encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] -**taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the swarm. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] | +| **raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] | +| **dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] | +| **caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] | +| **encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] | +| **taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecCAConfig.md b/api-model-v1-45/docs/SwarmSpecCAConfig.md index 9834a10b..72a0dca2 100644 --- a/api-model-v1-45/docs/SwarmSpecCAConfig.md +++ b/api-model-v1-45/docs/SwarmSpecCAConfig.md @@ -2,13 +2,13 @@ # SwarmSpecCAConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] -**externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] -**signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] -**signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] -**forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] | +| **externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] | +| **signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecCAConfigExternalCAsInner.md b/api-model-v1-45/docs/SwarmSpecCAConfigExternalCAsInner.md index b8281c30..d4e29b6c 100644 --- a/api-model-v1-45/docs/SwarmSpecCAConfigExternalCAsInner.md +++ b/api-model-v1-45/docs/SwarmSpecCAConfigExternalCAsInner.md @@ -2,19 +2,19 @@ # SwarmSpecCAConfigExternalCAsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] -**URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] -**caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] | +| **URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] | +| **caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] | ## Enum: Protocol -Name | Value ----- | ----- -protocol | cfssl +| Name | Value | +| ---- | ----- | +| protocol | cfssl | diff --git a/api-model-v1-45/docs/SwarmSpecDispatcher.md b/api-model-v1-45/docs/SwarmSpecDispatcher.md index 3c26d6e3..281781e0 100644 --- a/api-model-v1-45/docs/SwarmSpecDispatcher.md +++ b/api-model-v1-45/docs/SwarmSpecDispatcher.md @@ -2,9 +2,9 @@ # SwarmSpecDispatcher ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecEncryptionConfig.md b/api-model-v1-45/docs/SwarmSpecEncryptionConfig.md index 77123bf9..f26480bf 100644 --- a/api-model-v1-45/docs/SwarmSpecEncryptionConfig.md +++ b/api-model-v1-45/docs/SwarmSpecEncryptionConfig.md @@ -2,9 +2,9 @@ # SwarmSpecEncryptionConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecOrchestration.md b/api-model-v1-45/docs/SwarmSpecOrchestration.md index 39e39025..1152816f 100644 --- a/api-model-v1-45/docs/SwarmSpecOrchestration.md +++ b/api-model-v1-45/docs/SwarmSpecOrchestration.md @@ -2,9 +2,9 @@ # SwarmSpecOrchestration ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecRaft.md b/api-model-v1-45/docs/SwarmSpecRaft.md index 4b288996..c31ecfa2 100644 --- a/api-model-v1-45/docs/SwarmSpecRaft.md +++ b/api-model-v1-45/docs/SwarmSpecRaft.md @@ -2,13 +2,13 @@ # SwarmSpecRaft ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] -**keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] -**logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] -**electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] -**heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] | +| **keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] | +| **logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] | +| **electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | +| **heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecTaskDefaults.md b/api-model-v1-45/docs/SwarmSpecTaskDefaults.md index 499a926b..acb39d26 100644 --- a/api-model-v1-45/docs/SwarmSpecTaskDefaults.md +++ b/api-model-v1-45/docs/SwarmSpecTaskDefaults.md @@ -2,9 +2,9 @@ # SwarmSpecTaskDefaults ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] | diff --git a/api-model-v1-45/docs/SwarmSpecTaskDefaultsLogDriver.md b/api-model-v1-45/docs/SwarmSpecTaskDefaultsLogDriver.md index 0f0df03c..8394a880 100644 --- a/api-model-v1-45/docs/SwarmSpecTaskDefaultsLogDriver.md +++ b/api-model-v1-45/docs/SwarmSpecTaskDefaultsLogDriver.md @@ -2,10 +2,10 @@ # SwarmSpecTaskDefaultsLogDriver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] | diff --git a/api-model-v1-45/docs/SwarmUnlockRequest.md b/api-model-v1-45/docs/SwarmUnlockRequest.md index ddf81767..0f2b14e8 100644 --- a/api-model-v1-45/docs/SwarmUnlockRequest.md +++ b/api-model-v1-45/docs/SwarmUnlockRequest.md @@ -2,9 +2,9 @@ # SwarmUnlockRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | diff --git a/api-model-v1-45/docs/SystemAuthResponse.md b/api-model-v1-45/docs/SystemAuthResponse.md index 69830deb..8681c17e 100644 --- a/api-model-v1-45/docs/SystemAuthResponse.md +++ b/api-model-v1-45/docs/SystemAuthResponse.md @@ -2,10 +2,10 @@ # SystemAuthResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **kotlin.String** | The status of the authentication | -**identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | **kotlin.String** | The status of the authentication | | +| **identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] | diff --git a/api-model-v1-45/docs/SystemDataUsageResponse.md b/api-model-v1-45/docs/SystemDataUsageResponse.md index 919d9273..36515e99 100644 --- a/api-model-v1-45/docs/SystemDataUsageResponse.md +++ b/api-model-v1-45/docs/SystemDataUsageResponse.md @@ -2,13 +2,13 @@ # SystemDataUsageResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**layersSize** | **kotlin.Long** | | [optional] -**images** | [**kotlin.collections.MutableList<ImageSummary>**](ImageSummary.md) | | [optional] -**containers** | [**kotlin.collections.MutableList<ContainerSummary>**](ContainerSummary.md) | | [optional] -**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | | [optional] -**buildCache** | [**kotlin.collections.MutableList<BuildCache>**](BuildCache.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **layersSize** | **kotlin.Long** | | [optional] | +| **images** | [**kotlin.collections.MutableList<ImageSummary>**](ImageSummary.md) | | [optional] | +| **containers** | [**kotlin.collections.MutableList<ContainerSummary>**](ContainerSummary.md) | | [optional] | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | | [optional] | +| **buildCache** | [**kotlin.collections.MutableList<BuildCache>**](BuildCache.md) | | [optional] | diff --git a/api-model-v1-45/docs/SystemInfo.md b/api-model-v1-45/docs/SystemInfo.md index b6799987..cd5f8854 100644 --- a/api-model-v1-45/docs/SystemInfo.md +++ b/api-model-v1-45/docs/SystemInfo.md @@ -2,90 +2,90 @@ # SystemInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] -**containers** | **kotlin.Int** | Total number of containers on the host. | [optional] -**containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] -**containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] -**containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] -**images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] -**driver** | **kotlin.String** | Name of the storage driver in use. | [optional] -**driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] -**dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] -**plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] -**memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] -**swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] -**kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. | [optional] -**cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] -**cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] -**cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] -**cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] -**pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] -**oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] -**ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] -**bridgeNfIptables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-iptables` is available on the host. | [optional] -**bridgeNfIp6tables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-ip6tables` is available on the host. | [optional] -**debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] -**nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] -**ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] -**systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] -**loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] -**cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] -**cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] -**neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] -**kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] -**operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] -**osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] -**osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] -**architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] -**NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] -**memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] -**indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] -**registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] -**genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] -**httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] -**httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] -**noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] -**name** | **kotlin.String** | Hostname of the host. | [optional] -**labels** | **kotlin.collections.MutableList<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] -**experimentalBuild** | **kotlin.Boolean** | Indicates if experimental features are enabled on the daemon. | [optional] -**serverVersion** | **kotlin.String** | Version string of the daemon. | [optional] -**runtimes** | [**kotlin.collections.MutableMap<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] -**defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] -**swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] -**liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] -**isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] -**initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] -**containerdCommit** | [**Commit**](Commit.md) | | [optional] -**runcCommit** | [**Commit**](Commit.md) | | [optional] -**initCommit** | [**Commit**](Commit.md) | | [optional] -**securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] -**productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] -**defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] -**cdISpecDirs** | **kotlin.collections.MutableList<kotlin.String>** | List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] | +| **containers** | **kotlin.Int** | Total number of containers on the host. | [optional] | +| **containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] | +| **containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] | +| **containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] | +| **images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] | +| **driver** | **kotlin.String** | Name of the storage driver in use. | [optional] | +| **driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | +| **dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] | +| **plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] | +| **memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] | +| **swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] | +| **kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. | [optional] | +| **cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] | +| **cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] | +| **cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] | +| **cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] | +| **pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] | +| **ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] | +| **bridgeNfIptables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-iptables` is available on the host. | [optional] | +| **bridgeNfIp6tables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-ip6tables` is available on the host. | [optional] | +| **debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] | +| **nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] | +| **ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] | +| **systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] | +| **cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] | +| **cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] | +| **neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] | +| **kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] | +| **operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] | +| **osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] | +| **osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] | +| **memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] | +| **indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] | +| **registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] | +| **name** | **kotlin.String** | Hostname of the host. | [optional] | +| **labels** | **kotlin.collections.MutableList<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] | +| **experimentalBuild** | **kotlin.Boolean** | Indicates if experimental features are enabled on the daemon. | [optional] | +| **serverVersion** | **kotlin.String** | Version string of the daemon. | [optional] | +| **runtimes** | [**kotlin.collections.MutableMap<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] | +| **defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] | +| **swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] | +| **liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] | +| **isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] | +| **initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **containerdCommit** | [**Commit**](Commit.md) | | [optional] | +| **runcCommit** | [**Commit**](Commit.md) | | [optional] | +| **initCommit** | [**Commit**](Commit.md) | | [optional] | +| **securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] | +| **productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] | +| **defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] | +| **cdISpecDirs** | **kotlin.collections.MutableList<kotlin.String>** | List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. | [optional] | ## Enum: CgroupDriver -Name | Value ----- | ----- -cgroupDriver | cgroupfs, systemd, none +| Name | Value | +| ---- | ----- | +| cgroupDriver | cgroupfs, systemd, none | ## Enum: CgroupVersion -Name | Value ----- | ----- -cgroupVersion | 1, 2 +| Name | Value | +| ---- | ----- | +| cgroupVersion | 1, 2 | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, hyperv, process +| Name | Value | +| ---- | ----- | +| isolation | default, hyperv, process | diff --git a/api-model-v1-45/docs/SystemInfoDefaultAddressPoolsInner.md b/api-model-v1-45/docs/SystemInfoDefaultAddressPoolsInner.md index d24cff78..1db98475 100644 --- a/api-model-v1-45/docs/SystemInfoDefaultAddressPoolsInner.md +++ b/api-model-v1-45/docs/SystemInfoDefaultAddressPoolsInner.md @@ -2,10 +2,10 @@ # SystemInfoDefaultAddressPoolsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**base** | **kotlin.String** | The network address in CIDR format | [optional] -**propertySize** | **kotlin.Int** | The network pool size | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **base** | **kotlin.String** | The network address in CIDR format | [optional] | +| **propertySize** | **kotlin.Int** | The network pool size | [optional] | diff --git a/api-model-v1-45/docs/SystemVersion.md b/api-model-v1-45/docs/SystemVersion.md index ec9c592d..cead3f34 100644 --- a/api-model-v1-45/docs/SystemVersion.md +++ b/api-model-v1-45/docs/SystemVersion.md @@ -2,20 +2,20 @@ # SystemVersion ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] -**components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] -**version** | **kotlin.String** | The version of the daemon | [optional] -**apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] -**minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] -**gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] -**goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] -**os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] -**arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] -**kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] -**experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] -**buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] | +| **components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] | +| **version** | **kotlin.String** | The version of the daemon | [optional] | +| **apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] | +| **minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] | +| **gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] | +| **goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] | +| **os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] | +| **arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] | +| **kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] | +| **experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] | +| **buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] | diff --git a/api-model-v1-45/docs/SystemVersionComponentsInner.md b/api-model-v1-45/docs/SystemVersionComponentsInner.md index d9a2c88f..804428ca 100644 --- a/api-model-v1-45/docs/SystemVersionComponentsInner.md +++ b/api-model-v1-45/docs/SystemVersionComponentsInner.md @@ -2,11 +2,11 @@ # SystemVersionComponentsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the component | -**version** | **kotlin.String** | Version of the component | -**details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the component | | +| **version** | **kotlin.String** | Version of the component | | +| **details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] | diff --git a/api-model-v1-45/docs/SystemVersionPlatform.md b/api-model-v1-45/docs/SystemVersionPlatform.md index 35bad2df..285b4a47 100644 --- a/api-model-v1-45/docs/SystemVersionPlatform.md +++ b/api-model-v1-45/docs/SystemVersionPlatform.md @@ -2,9 +2,9 @@ # SystemVersionPlatform ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | diff --git a/api-model-v1-45/docs/TLSInfo.md b/api-model-v1-45/docs/TLSInfo.md index 9b15c9b3..27168d2c 100644 --- a/api-model-v1-45/docs/TLSInfo.md +++ b/api-model-v1-45/docs/TLSInfo.md @@ -2,11 +2,11 @@ # TLSInfo ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] -**certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] -**certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] | +| **certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] | +| **certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] | diff --git a/api-model-v1-45/docs/Task.md b/api-model-v1-45/docs/Task.md index 87037581..f68e5e2f 100644 --- a/api-model-v1-45/docs/Task.md +++ b/api-model-v1-45/docs/Task.md @@ -2,22 +2,22 @@ # Task ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ID** | **kotlin.String** | The ID of the task. | [optional] -**version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] -**createdAt** | **kotlin.String** | | [optional] -**updatedAt** | **kotlin.String** | | [optional] -**name** | **kotlin.String** | Name of the task. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**spec** | [**TaskSpec**](TaskSpec.md) | | [optional] -**serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] -**slot** | **kotlin.Int** | | [optional] -**nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] -**assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] -**status** | [**TaskStatus**](TaskStatus.md) | | [optional] -**desiredState** | [**TaskState**](TaskState.md) | | [optional] -**jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the task. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | Name of the task. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **spec** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] | +| **slot** | **kotlin.Int** | | [optional] | +| **nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] | +| **assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **status** | [**TaskStatus**](TaskStatus.md) | | [optional] | +| **desiredState** | [**TaskState**](TaskState.md) | | [optional] | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpec.md b/api-model-v1-45/docs/TaskSpec.md index b008cdde..bf55bec5 100644 --- a/api-model-v1-45/docs/TaskSpec.md +++ b/api-model-v1-45/docs/TaskSpec.md @@ -2,18 +2,18 @@ # TaskSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] -**containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] -**networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] -**resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] -**restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] -**placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] -**forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] -**runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] -**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] -**logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] | +| **containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] | +| **networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] | +| **resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] | +| **restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] | +| **placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] | +| **forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] | +| **runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] | +| **logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpec.md b/api-model-v1-45/docs/TaskSpecContainerSpec.md index 163bc381..886b2b31 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpec.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpec.md @@ -2,42 +2,42 @@ # TaskSpecContainerSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**image** | **kotlin.String** | The image name to use for the container | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] -**command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] -**args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] -**hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] -**env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] -**dir** | **kotlin.String** | The working directory for commands to run in. | [optional] -**user** | **kotlin.String** | The user inside the container. | [optional] -**groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] -**privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] -**TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] -**openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] -**readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] -**mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] -**stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] -**stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] -**healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] -**hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] -**dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] -**secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] -**configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] -**isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] -**`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] -**sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] -**capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] -**capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] -**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **image** | **kotlin.String** | The image name to use for the container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] | +| **command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] | +| **dir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **user** | **kotlin.String** | The user inside the container. | [optional] | +| **groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] | +| **TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] | +| **stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] | +| **healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] | +| **dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] | +| **secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] | +| **configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] | +| **capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] | +| **capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] | ## Enum: Isolation -Name | Value ----- | ----- -isolation | default, process, hyperv +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInner.md b/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInner.md index ce88a95c..b3fd4ce2 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInner.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInner.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecConfigsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] -**runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] -**configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] -**configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] | +| **runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] | +| **configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] | +| **configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInnerFile.md b/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInnerFile.md index 7013e04f..8d06a999 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInnerFile.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecConfigsInnerFile.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecConfigsInnerFile ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] -**UID** | **kotlin.String** | UID represents the file UID. | [optional] -**GID** | **kotlin.String** | GID represents the file GID. | [optional] -**mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecDNSConfig.md b/api-model-v1-45/docs/TaskSpecContainerSpecDNSConfig.md index 75bff49a..e2f2192a 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecDNSConfig.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecDNSConfig.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecDNSConfig ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] -**search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] -**options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] | +| **search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecPrivileges.md b/api-model-v1-45/docs/TaskSpecContainerSpecPrivileges.md index 695113d6..03edb15c 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecPrivileges.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecPrivileges.md @@ -2,13 +2,13 @@ # TaskSpecContainerSpecPrivileges ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] -**seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] -**seccomp** | [**TaskSpecContainerSpecPrivilegesSeccomp**](TaskSpecContainerSpecPrivilegesSeccomp.md) | | [optional] -**appArmor** | [**TaskSpecContainerSpecPrivilegesAppArmor**](TaskSpecContainerSpecPrivilegesAppArmor.md) | | [optional] -**noNewPrivileges** | **kotlin.Boolean** | Configuration of the no_new_privs bit in the container | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] | +| **seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] | +| **seccomp** | [**TaskSpecContainerSpecPrivilegesSeccomp**](TaskSpecContainerSpecPrivilegesSeccomp.md) | | [optional] | +| **appArmor** | [**TaskSpecContainerSpecPrivilegesAppArmor**](TaskSpecContainerSpecPrivilegesAppArmor.md) | | [optional] | +| **noNewPrivileges** | **kotlin.Boolean** | Configuration of the no_new_privs bit in the container | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesAppArmor.md b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesAppArmor.md index c580273c..9551f4bc 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesAppArmor.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesAppArmor.md @@ -2,16 +2,16 @@ # TaskSpecContainerSpecPrivilegesAppArmor ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**inline**](#Mode) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | ## Enum: Mode -Name | Value ----- | ----- -mode | default, disabled +| Name | Value | +| ---- | ----- | +| mode | default, disabled | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md index 169c37fe..427e0c31 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecPrivilegesCredentialSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] -**file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] -**registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md index a5e466e8..996b8470 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md @@ -2,13 +2,13 @@ # TaskSpecContainerSpecPrivilegesSELinuxContext ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**disable** | **kotlin.Boolean** | Disable SELinux | [optional] -**user** | **kotlin.String** | SELinux user label | [optional] -**role** | **kotlin.String** | SELinux role label | [optional] -**type** | **kotlin.String** | SELinux type label | [optional] -**level** | **kotlin.String** | SELinux level label | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **disable** | **kotlin.Boolean** | Disable SELinux | [optional] | +| **user** | **kotlin.String** | SELinux user label | [optional] | +| **role** | **kotlin.String** | SELinux role label | [optional] | +| **type** | **kotlin.String** | SELinux type label | [optional] | +| **level** | **kotlin.String** | SELinux level label | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSeccomp.md b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSeccomp.md index 2c64b58c..8eb1cf79 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSeccomp.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecPrivilegesSeccomp.md @@ -2,17 +2,17 @@ # TaskSpecContainerSpecPrivilegesSeccomp ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mode** | [**inline**](#Mode) | | [optional] -**profile** | **kotlin.String** | The custom seccomp profile as a json object | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | +| **profile** | **kotlin.String** | The custom seccomp profile as a json object | [optional] | ## Enum: Mode -Name | Value ----- | ----- -mode | default, unconfined, custom +| Name | Value | +| ---- | ----- | +| mode | default, unconfined, custom | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInner.md b/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInner.md index e20b3a06..11d5721e 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInner.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInner.md @@ -2,11 +2,11 @@ # TaskSpecContainerSpecSecretsInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] -**secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] -**secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] | +| **secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] | +| **secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInnerFile.md b/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInnerFile.md index af42e3f3..c90d914f 100644 --- a/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInnerFile.md +++ b/api-model-v1-45/docs/TaskSpecContainerSpecSecretsInnerFile.md @@ -2,12 +2,12 @@ # TaskSpecContainerSpecSecretsInnerFile ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] -**UID** | **kotlin.String** | UID represents the file UID. | [optional] -**GID** | **kotlin.String** | GID represents the file GID. | [optional] -**mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecLogDriver.md b/api-model-v1-45/docs/TaskSpecLogDriver.md index a0cfb139..be81c423 100644 --- a/api-model-v1-45/docs/TaskSpecLogDriver.md +++ b/api-model-v1-45/docs/TaskSpecLogDriver.md @@ -2,10 +2,10 @@ # TaskSpecLogDriver ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | | [optional] -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecNetworkAttachmentSpec.md b/api-model-v1-45/docs/TaskSpecNetworkAttachmentSpec.md index 1b6fcbe5..ae098a2f 100644 --- a/api-model-v1-45/docs/TaskSpecNetworkAttachmentSpec.md +++ b/api-model-v1-45/docs/TaskSpecNetworkAttachmentSpec.md @@ -2,9 +2,9 @@ # TaskSpecNetworkAttachmentSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**containerID** | **kotlin.String** | ID of the container represented by this task | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | ID of the container represented by this task | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecPlacement.md b/api-model-v1-45/docs/TaskSpecPlacement.md index 8477a6fe..0b5caddb 100644 --- a/api-model-v1-45/docs/TaskSpecPlacement.md +++ b/api-model-v1-45/docs/TaskSpecPlacement.md @@ -2,12 +2,12 @@ # TaskSpecPlacement ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] -**preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] -**maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] -**platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] | +| **preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] | +| **maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] | +| **platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecPlacementPreferencesInner.md b/api-model-v1-45/docs/TaskSpecPlacementPreferencesInner.md index a5f6f559..2894f7e5 100644 --- a/api-model-v1-45/docs/TaskSpecPlacementPreferencesInner.md +++ b/api-model-v1-45/docs/TaskSpecPlacementPreferencesInner.md @@ -2,9 +2,9 @@ # TaskSpecPlacementPreferencesInner ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecPlacementPreferencesInnerSpread.md b/api-model-v1-45/docs/TaskSpecPlacementPreferencesInnerSpread.md index c1d686b6..9643c6ae 100644 --- a/api-model-v1-45/docs/TaskSpecPlacementPreferencesInnerSpread.md +++ b/api-model-v1-45/docs/TaskSpecPlacementPreferencesInnerSpread.md @@ -2,9 +2,9 @@ # TaskSpecPlacementPreferencesInnerSpread ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecPluginSpec.md b/api-model-v1-45/docs/TaskSpecPluginSpec.md index 7adb8c81..45eb9382 100644 --- a/api-model-v1-45/docs/TaskSpecPluginSpec.md +++ b/api-model-v1-45/docs/TaskSpecPluginSpec.md @@ -2,12 +2,12 @@ # TaskSpecPluginSpec ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] -**remote** | **kotlin.String** | The plugin image reference to use. | [optional] -**disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] -**pluginPrivilege** | [**kotlin.collections.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] | +| **remote** | **kotlin.String** | The plugin image reference to use. | [optional] | +| **disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] | +| **pluginPrivilege** | [**kotlin.collections.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecResources.md b/api-model-v1-45/docs/TaskSpecResources.md index 7ac6cc70..531e9943 100644 --- a/api-model-v1-45/docs/TaskSpecResources.md +++ b/api-model-v1-45/docs/TaskSpecResources.md @@ -2,10 +2,10 @@ # TaskSpecResources ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limits** | [**Limit**](Limit.md) | | [optional] -**reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **limits** | [**Limit**](Limit.md) | | [optional] | +| **reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] | diff --git a/api-model-v1-45/docs/TaskSpecRestartPolicy.md b/api-model-v1-45/docs/TaskSpecRestartPolicy.md index 747d8ee4..d139ec81 100644 --- a/api-model-v1-45/docs/TaskSpecRestartPolicy.md +++ b/api-model-v1-45/docs/TaskSpecRestartPolicy.md @@ -2,19 +2,19 @@ # TaskSpecRestartPolicy ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**condition** | [**inline**](#Condition) | Condition for restart. | [optional] -**delay** | **kotlin.Long** | Delay between restart attempts. | [optional] -**maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] -**window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **condition** | [**inline**](#Condition) | Condition for restart. | [optional] | +| **delay** | **kotlin.Long** | Delay between restart attempts. | [optional] | +| **maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] | +| **window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] | ## Enum: Condition -Name | Value ----- | ----- -condition | none, on-failure, any +| Name | Value | +| ---- | ----- | +| condition | none, on-failure, any | diff --git a/api-model-v1-45/docs/TaskStatus.md b/api-model-v1-45/docs/TaskStatus.md index 9129650b..347db437 100644 --- a/api-model-v1-45/docs/TaskStatus.md +++ b/api-model-v1-45/docs/TaskStatus.md @@ -2,14 +2,14 @@ # TaskStatus ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**timestamp** | **kotlin.String** | | [optional] -**state** | [**TaskState**](TaskState.md) | | [optional] -**message** | **kotlin.String** | | [optional] -**err** | **kotlin.String** | | [optional] -**containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] -**portStatus** | [**PortStatus**](PortStatus.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **timestamp** | **kotlin.String** | | [optional] | +| **state** | [**TaskState**](TaskState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **err** | **kotlin.String** | | [optional] | +| **containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] | +| **portStatus** | [**PortStatus**](PortStatus.md) | | [optional] | diff --git a/api-model-v1-45/docs/ThrottleDevice.md b/api-model-v1-45/docs/ThrottleDevice.md index 6fedc91a..a4dbeb34 100644 --- a/api-model-v1-45/docs/ThrottleDevice.md +++ b/api-model-v1-45/docs/ThrottleDevice.md @@ -2,10 +2,10 @@ # ThrottleDevice ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path** | **kotlin.String** | Device path | [optional] -**rate** | **kotlin.Long** | Rate | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Device path | [optional] | +| **rate** | **kotlin.Long** | Rate | [optional] | diff --git a/api-model-v1-45/docs/UnlockKeyResponse.md b/api-model-v1-45/docs/UnlockKeyResponse.md index f2d7fe19..e530f063 100644 --- a/api-model-v1-45/docs/UnlockKeyResponse.md +++ b/api-model-v1-45/docs/UnlockKeyResponse.md @@ -2,9 +2,9 @@ # UnlockKeyResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | diff --git a/api-model-v1-45/docs/Volume.md b/api-model-v1-45/docs/Volume.md index 836fe611..25fce51e 100644 --- a/api-model-v1-45/docs/Volume.md +++ b/api-model-v1-45/docs/Volume.md @@ -2,25 +2,25 @@ # Volume ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | Name of the volume. | -**driver** | **kotlin.String** | Name of the volume driver used by the volume. | -**mountpoint** | **kotlin.String** | Mount path of the volume on the host. | -**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | -**createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] -**status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] -**clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] -**usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the volume. | | +| **driver** | **kotlin.String** | Name of the volume driver used by the volume. | | +| **mountpoint** | **kotlin.String** | Mount path of the volume on the host. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | | +| **createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] | +| **status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] | +| **clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] | +| **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] | ## Enum: Scope -Name | Value ----- | ----- -scope | local, global +| Name | Value | +| ---- | ----- | +| scope | local, global | diff --git a/api-model-v1-45/docs/VolumeCreateOptions.md b/api-model-v1-45/docs/VolumeCreateOptions.md index 5fb7d701..e6402768 100644 --- a/api-model-v1-45/docs/VolumeCreateOptions.md +++ b/api-model-v1-45/docs/VolumeCreateOptions.md @@ -2,13 +2,13 @@ # VolumeCreateOptions ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] -**driver** | **kotlin.String** | Name of the volume driver to use. | [optional] -**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] -**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] | +| **driver** | **kotlin.String** | Name of the volume driver to use. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/VolumeListResponse.md b/api-model-v1-45/docs/VolumeListResponse.md index 55a70700..832e8349 100644 --- a/api-model-v1-45/docs/VolumeListResponse.md +++ b/api-model-v1-45/docs/VolumeListResponse.md @@ -2,10 +2,10 @@ # VolumeListResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] -**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] | diff --git a/api-model-v1-45/docs/VolumePruneResponse.md b/api-model-v1-45/docs/VolumePruneResponse.md index bd4d15c5..e1b6e248 100644 --- a/api-model-v1-45/docs/VolumePruneResponse.md +++ b/api-model-v1-45/docs/VolumePruneResponse.md @@ -2,10 +2,10 @@ # VolumePruneResponse ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] -**spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | diff --git a/api-model-v1-45/docs/VolumeUpdateRequest.md b/api-model-v1-45/docs/VolumeUpdateRequest.md index a4b0a8de..8988303b 100644 --- a/api-model-v1-45/docs/VolumeUpdateRequest.md +++ b/api-model-v1-45/docs/VolumeUpdateRequest.md @@ -2,9 +2,9 @@ # VolumeUpdateRequest ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | diff --git a/api-model-v1-45/docs/VolumeUsageData.md b/api-model-v1-45/docs/VolumeUsageData.md index 2f9df591..442e3a02 100644 --- a/api-model-v1-45/docs/VolumeUsageData.md +++ b/api-model-v1-45/docs/VolumeUsageData.md @@ -2,10 +2,10 @@ # VolumeUsageData ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | -**refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | | +| **refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | |