<?php

declare(strict_types=1);

namespace Docker\API;

class Client extends Runtime\Client\Client

{

/**

* Returns a list of containers. For details on the format, see the

* [inspect endpoint](#operation/ContainerInspect).

*

* Note that it uses a different, smaller representation of a container

* than inspecting a single container. For example, the list of linked

* containers is not propagated .

*

* @param array $queryParameters {

*

* @var bool $all Return all containers. By default, only running containers are shown.

* @var int $limit return this number of most recently created containers, including

* non-running ones

* @var bool $size return the size of container as fields `SizeRw` and `SizeRootFs`

* @var string $filters Filters to process on the container list, encoded as JSON (a

* `map[string][]string`). For example, `{"status": ["paused"]}` will

* only return paused containers.

*

* Available filters:

*

* - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)

* - `before`=(`<container id>` or `<container name>`)

* - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)

* - `exited=<int>` containers with exit code of `<int>`

* - `health`=(`starting`|`healthy`|`unhealthy`|`none`)

* - `id=<ID>` a container's ID

* - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)

* - `is-task=`(`true`|`false`)

* - `label=key` or `label="key=value"` of a container label

* - `name=<name>` a container's name

* - `network`=(`<network id>` or `<network name>`)

* - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)

* - `since`=(`<container id>` or `<container name>`)

* - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)

* - `volume`=(`<volume name>` or `<mount point destination>`)

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerListBadRequestException

* @throws Exception\ContainerListInternalServerErrorException

*

* @return Model\ContainerSummary[]|\Psr\Http\Message\ResponseInterface|null

*/

public function containerList(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerList($queryParameters), $fetch);

}

/**

* @param array $queryParameters {

*

* @var string $name Assign the specified name to the container. Must match

* `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.

* @var string $platform Platform in the format `os[/arch[/variant]]` used for image lookup.

*

* When specified, the daemon checks if the requested image is present

* in the local image cache with the given OS and Architecture, and

* otherwise returns a `404` status.

*

* If the option is not set, the host's native OS and Architecture are

* used to look up the image in the image cache. However, if no platform

* is passed and the given image does exist in the local image cache,

* but its OS or architecture does not match, the container is created

* with the available image, and a warning is added to the `Warnings`

* field in the response, for example;

*

* WARNING: The requested image's platform (linux/arm64/v8) does not

* match the detected host platform (linux/amd64) and no

* specific platform was requested

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerCreateBadRequestException

* @throws Exception\ContainerCreateNotFoundException

* @throws Exception\ContainerCreateConflictException

* @throws Exception\ContainerCreateInternalServerErrorException

*

* @return Model\ContainerCreateResponse|\Psr\Http\Message\ResponseInterface|null

*/

public function containerCreate(?Model\ContainersCreatePostBody $requestBody = null, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerCreate($requestBody, $queryParameters), $fetch);

}

/**

* Return low-level information about a container.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var bool $size Return the size of container as fields `SizeRw` and `SizeRootFs`

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerInspectNotFoundException

* @throws Exception\ContainerInspectInternalServerErrorException

*

* @return Model\ContainersIdJsonGetResponse200|\Psr\Http\Message\ResponseInterface|null

*/

public function containerInspect(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerInspect($id, $queryParameters), $fetch);

}

/**

* On Unix systems, this is done by running the `ps` command. This endpoint

* is not supported on Windows.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $ps_args The arguments to pass to `ps`. For example, `aux`

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerTopNotFoundException

* @throws Exception\ContainerTopInternalServerErrorException

*

* @return Model\ContainersIdTopGetJsonResponse200|\Psr\Http\Message\ResponseInterface|null

*/

public function containerTop(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerTop($id, $queryParameters, $accept), $fetch);

}

/**

* Get `stdout` and `stderr` logs from a container.

*

* Note: This endpoint works only for containers with the `json-file` or

* `journald` logging driver.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var bool $follow keep connection after returning logs

* @var bool $stdout Return logs from `stdout`

* @var bool $stderr Return logs from `stderr`

* @var int $since Only return logs since this time, as a UNIX timestamp

* @var int $until Only return logs before this time, as a UNIX timestamp

* @var bool $timestamps Add timestamps to every log line

* @var string $tail Only return this number of log lines from the end of the logs.

* Specify as an integer or `all` to output all log lines.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/vnd.docker.raw-stream|application/vnd.docker.multiplexed-stream|application/json

*

* @throws Exception\ContainerLogsNotFoundException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerLogs(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerLogs($id, $queryParameters, $accept), $fetch);

}

/**

* Returns which files in a container's filesystem have been added, deleted,

* or modified. The `Kind` of modification can be one of:

*

* - `0`: Modified ("C")

* - `1`: Added ("A")

* - `2`: Deleted ("D")

*

* @param string $id ID or name of the container

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerChangesNotFoundException

* @throws Exception\ContainerChangesInternalServerErrorException

*

* @return Model\FilesystemChange[]|\Psr\Http\Message\ResponseInterface|null

*/

public function containerChanges(string $id, string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerChanges($id), $fetch);

}

/**

* Export the contents of a container as a tarball.

*

* @param string $id ID or name of the container

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/octet-stream|application/json

*

* @throws Exception\ContainerExportNotFoundException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerExport(string $id, string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerExport($id, $accept), $fetch);

}

/**

* This endpoint returns a live stream of a container’s resource usage

* statistics.

*

* The `precpu_stats` is the CPU statistic of the *previous* read, and is

* used to calculate the CPU usage percentage. It is not an exact copy

* of the `cpu_stats` field.

*

* If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is

* nil then for compatibility with older daemons the length of the

* corresponding `cpu_usage.percpu_usage` array should be used.

*

* On a cgroup v2 host, the following fields are not set

* `blkio_stats`: all fields other than `io_service_bytes_recursive`

* `cpu_stats`: `cpu_usage.percpu_usage`

* `memory_stats`: `max_usage` and `failcnt`

* Also, `memory_stats.stats` fields are incompatible with cgroup v1.

*

* To calculate the values shown by the `stats` command of the docker cli tool

* the following formulas can be used:

* used_memory = `memory_stats.usage - memory_stats.stats.cache`

* available_memory = `memory_stats.limit`

* Memory usage % = `(used_memory / available_memory) * 100.0`

* cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`

* system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`

* number_cpus = `lenght(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus`

* CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var bool $stream Stream the output. If false, the stats will be output once and then

* it will disconnect.

* @var bool $one-shot Only get a single stat instead of waiting for 2 cycles. Must be used

* with `stream=false`.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerStatsNotFoundException

* @throws Exception\ContainerStatsInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerStats(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerStats($id, $queryParameters), $fetch);

}

/**

* Resize the TTY for a container.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var int $h Height of the TTY session in characters

* @var int $w Width of the TTY session in characters

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header text/plain|application/json

*

* @throws Exception\ContainerResizeNotFoundException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerResize(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerResize($id, $queryParameters, $accept), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $detachKeys 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 `_`.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerStartNotFoundException

* @throws Exception\ContainerStartInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerStart(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerStart($id, $queryParameters, $accept), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $signal Signal to send to the container as an integer or string (e.g. `SIGINT`).

* @var int $t Number of seconds to wait before killing the container

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerStopNotFoundException

* @throws Exception\ContainerStopInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerStop(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerStop($id, $queryParameters, $accept), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $signal Signal to send to the container as an integer or string (e.g. `SIGINT`).

* @var int $t Number of seconds to wait before killing the container

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerRestartNotFoundException

* @throws Exception\ContainerRestartInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerRestart(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerRestart($id, $queryParameters, $accept), $fetch);

}

/**

* Send a POSIX signal to a container, defaulting to killing to the

* container.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $signal Signal to send to the container as an integer or string (e.g. `SIGINT`).

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerKillNotFoundException

* @throws Exception\ContainerKillConflictException

* @throws Exception\ContainerKillInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerKill(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerKill($id, $queryParameters, $accept), $fetch);

}

/**

* Change various configuration options of a container without having to

* recreate it.

*

* @param string $id ID or name of the container

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerUpdateNotFoundException

* @throws Exception\ContainerUpdateInternalServerErrorException

*

* @return Model\ContainersIdUpdatePostResponse200|\Psr\Http\Message\ResponseInterface|null

*/

public function containerUpdate(string $id, ?Model\ContainersIdUpdatePostBody $requestBody = null, string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerUpdate($id, $requestBody), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $name New name for the container

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerRenameNotFoundException

* @throws Exception\ContainerRenameConflictException

* @throws Exception\ContainerRenameInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerRename(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerRename($id, $queryParameters, $accept), $fetch);

}

/**

* Use the freezer cgroup to suspend all processes in a container.

*

* Traditionally, when suspending a process the `SIGSTOP` signal is used,

* which is observable by the process being suspended. With the freezer

* cgroup the process is unaware, and unable to capture, that it is being

* suspended, and subsequently resumed.

*

* @param string $id ID or name of the container

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerPauseNotFoundException

* @throws Exception\ContainerPauseInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerPause(string $id, string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerPause($id, $accept), $fetch);

}

/**

* Resume a container which has been paused.

*

* @param string $id ID or name of the container

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerUnpauseNotFoundException

* @throws Exception\ContainerUnpauseInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerUnpause(string $id, string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerUnpause($id, $accept), $fetch);

}

/**

* Attach to a container to read its output or send it input. You can attach

* to the same container multiple times and you can reattach to containers

* that have been detached.

*

* Either the `stream` or `logs` parameter must be `true` for this endpoint

* to do anything.

*

* See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)

* for more details.

*

* ### Hijacking

*

* This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,

* and `stderr` on the same socket.

*

* This is the response from the daemon for an attach request:

*

* ```

* HTTP/1.1 200 OK

* Content-Type: application/vnd.docker.raw-stream

*

* [STREAM]

* ```

*

* After the headers and two new lines, the TCP connection can now be used

* for raw, bidirectional communication between the client and server.

*

* To hint potential proxies about connection hijacking, the Docker client

* can also optionally send connection upgrade headers.

*

* For example, the client sends this request to upgrade the connection:

*

* ```

* POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1

* Upgrade: tcp

* Connection: Upgrade

* ```

*

* The Docker daemon will respond with a `101 UPGRADED` response, and will

* similarly follow with the raw stream:

*

* ```

* HTTP/1.1 101 UPGRADED

* Content-Type: application/vnd.docker.raw-stream

* Connection: Upgrade

* Upgrade: tcp

*

* [STREAM]

* ```

*

* ### Stream format

*

* When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),

* the HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream

* and the stream over the hijacked connected is multiplexed to separate out

* `stdout` and `stderr`. The stream consists of a series of frames, each

* containing a header and a payload.

*

* The header contains the information which the stream writes (`stdout` or

* `stderr`). It also contains the size of the associated frame encoded in

* the last four bytes (`uint32`).

*

* It is encoded on the first eight bytes like this:

*

* ```go

* header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}

* ```

*

* `STREAM_TYPE` can be:

*

* - 0: `stdin` (is written on `stdout`)

* - 1: `stdout`

* - 2: `stderr`

*

* `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size

* encoded as big endian.

*

* Following the header is the payload, which is the specified number of

* bytes of `STREAM_TYPE`.

*

* The simplest way to implement this protocol is the following:

*

* 1. Read 8 bytes.

* 2. Choose `stdout` or `stderr` depending on the first byte.

* 3. Extract the frame size from the last four bytes.

* 4. Read the extracted size and output it on the correct output.

* 5. Goto 1.

*

* ### Stream format when using a TTY

*

* When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),

* the stream is not multiplexed. The data exchanged over the hijacked

* connection is simply the raw data from the process PTY and client's

* `stdin`.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $detachKeys 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 `_`.

* @var bool $logs Replay previous logs from the container.

*

* This is useful for attaching to a container that has started and you

* want to output everything since the container started.

*

* If `stream` is also enabled, once all the previous output has been

* returned, it will seamlessly transition into streaming current

* output.

* @var bool $stream stream attached streams from the time the request was made onwards

* @var bool $stdin Attach to `stdin`

* @var bool $stdout Attach to `stdout`

* @var bool $stderr Attach to `stderr`

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/vnd.docker.raw-stream|application/vnd.docker.multiplexed-stream|application/json

*

* @throws Exception\ContainerAttachNotFoundException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerAttach(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerAttach($id, $queryParameters, $accept), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $detachKeys 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 `_`.

* @var bool $logs Return logs

* @var bool $stream Return stream

* @var bool $stdin Attach to `stdin`

* @var bool $stdout Attach to `stdout`

* @var bool $stderr Attach to `stderr`

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerAttachWebsocketBadRequestException

* @throws Exception\ContainerAttachWebsocketNotFoundException

* @throws Exception\ContainerAttachWebsocketInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerAttachWebsocket(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerAttachWebsocket($id, $queryParameters, $accept), $fetch);

}

/**

* Block until a container stops, then returns the exit code.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $condition Wait until a container state reaches the given condition.

*

* Defaults to `not-running` if omitted or empty.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerWaitBadRequestException

* @throws Exception\ContainerWaitNotFoundException

* @throws Exception\ContainerWaitInternalServerErrorException

*

* @return Model\ContainerWaitResponse|\Psr\Http\Message\ResponseInterface|null

*/

public function containerWait(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerWait($id, $queryParameters), $fetch);

}

/**

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var bool $v remove anonymous volumes associated with the container

* @var bool $force if the container is running, kill it before removing it

* @var bool $link Remove the specified link associated with the container.

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerDeleteBadRequestException

* @throws Exception\ContainerDeleteNotFoundException

* @throws Exception\ContainerDeleteConflictException

* @throws Exception\ContainerDeleteInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerDelete(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerDelete($id, $queryParameters, $accept), $fetch);

}

/**

* Get a tar archive of a resource in the filesystem of container id.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $path Resource in the container’s filesystem to archive.

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/x-tar|application/json

*

* @throws Exception\ContainerArchiveNotFoundException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerArchive(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerArchive($id, $queryParameters, $accept), $fetch);

}

/**

* A response header `X-Docker-Container-Path-Stat` is returned, containing

* a base64 - encoded JSON object with some filesystem header information

* about the path.

*

* @param string $id ID or name of the container

* @param array $queryParameters {

*

* @var string $path Resource in the container’s filesystem to archive.

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\ContainerArchiveInfoBadRequestException

* @throws Exception\ContainerArchiveInfoNotFoundException

* @throws Exception\ContainerArchiveInfoInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function containerArchiveInfo(string $id, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\ContainerArchiveInfo($id, $queryParameters, $accept), $fetch);

}

/**

* Upload a tar archive to be extracted to a path in the filesystem of container id.

* `path` parameter is asserted to be a directory. If it exists as a file, 400 error

* will be returned with message "not a directory".

*

* @param string $id ID or name of the container

* @param string|resource|\Psr\Http\Message\StreamInterface|null $requestBody

* @param array $queryParameters {

*

* @var string $path path to a directory in the container to extract the archive’s contents into

* @var string $noOverwriteDirNonDir if `1`, `true`, or `True` then it will be an error if unpacking the

* given content would cause an existing directory to be replaced with

* a non-directory and vice versa

* @var string $copyUIDGID If `1`, `true`, then it will copy UID/GID maps to the dest file or

* dir

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

* @param array $accept Accept content header application/json|text/plain

*

* @throws Exception\PutContainerArchiveBadRequestException

* @throws Exception\PutContainerArchiveForbiddenException

* @throws Exception\PutContainerArchiveNotFoundException

* @throws Exception\PutContainerArchiveInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function putContainerArchive(string $id, $requestBody = null, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])

{

return $this->executeEndpoint(new Endpoint\PutContainerArchive($id, $requestBody, $queryParameters, $accept), $fetch);

}

/**

* @param array $queryParameters {

*

* @var string $filters Filters to process on the prune list, encoded as JSON (a `map[string][]string`).

*

* Available filters:

* - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.

* - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ContainerPruneInternalServerErrorException

*

* @return Model\ContainersPrunePostResponse200|\Psr\Http\Message\ResponseInterface|null

*/

public function containerPrune(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ContainerPrune($queryParameters), $fetch);

}

/**

* Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

*

* @param array $queryParameters {

*

* @var bool $all Show all images. Only images from a final layer (no children) are shown by default.

* @var string $filters A JSON encoded value of the filters (a `map[string][]string`) to

* process on the images list.

*

* Available filters:

*

* - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)

* - `dangling=true`

* - `label=key` or `label="key=value"` of an image label

* - `reference`=(`<image-name>[:<tag>]`)

* - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)

* - `until=<timestamp>`

* @var bool $shared-size Compute and show shared size as a `SharedSize` field on each image

* @var bool $digests Show digest information as a `RepoDigests` field on each image.

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ImageListInternalServerErrorException

*

* @return Model\ImageSummary[]|\Psr\Http\Message\ResponseInterface|null

*/

public function imageList(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ImageList($queryParameters), $fetch);

}

/**

* Build an image from a tar archive with a `Dockerfile` in it.

*

* The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).

*

* The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.

*

* The build is canceled if the client drops the connection by quitting or being killed.

*

* @param string|resource|\Psr\Http\Message\StreamInterface|null $requestBody

* @param array $queryParameters {

*

* @var string $dockerfile Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.

* @var string $t A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.

* @var string $extrahosts Extra hosts to add to /etc/hosts

* @var string $remote A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.

* @var bool $q suppress verbose build output

* @var bool $nocache do not use the cache when building the image

* @var string $cachefrom JSON array of images used for build cache resolution

* @var string $pull attempt to pull the image even if an older image exists locally

* @var bool $rm remove intermediate containers after a successful build

* @var bool $forcerm always remove intermediate containers, even upon failure

* @var int $memory set memory limit for build

* @var int $memswap Total memory (memory + swap). Set as `-1` to disable swap.

* @var int $cpushares CPU shares (relative weight)

* @var string $cpusetcpus CPUs in which to allow execution (e.g., `0-3`, `0,1`).

* @var int $cpuperiod the length of a CPU period in microseconds

* @var int $cpuquota microseconds of CPU time that the container can get in a CPU period

* @var string $buildargs JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.

*

* For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This would result in the query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded.

*

* [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)

* @var int $shmsize Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.

* @var bool $squash Squash the resulting images layers into a single layer. *(Experimental release only.)*

* @var string $labels arbitrary key/value labels to set on the image, as a JSON map of string pairs

* @var string $networkmode Sets the networking mode for the run commands during build. Supported

* standard values are: `bridge`, `host`, `none`, and `container:<name|id>`.

* Any other value is taken as a custom network's name or ID to which this

* container should connect to.

* @var string $platform Platform in the format os[/arch[/variant]]

* @var string $target Target build stage

* @var string $outputs BuildKit output configuration

* @var string $version Version of the builder backend to use.

*

* - `1` is the first generation classic (deprecated) builder in the Docker daemon (default)

* - `2` is [BuildKit](https://github.com/moby/buildkit)

*

* }

*

* @param array $headerParameters {

*

* @var string $Content-type

* @var string $X-Registry-Config This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.

*

* The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:

*

* ```

* {

* "docker.example.com": {

* "username": "janedoe",

* "password": "hunter2"

* },

* "https://index.docker.io/v1/": {

* "username": "mobydock",

* "password": "conta1n3rize14"

* }

* }

* ```

*

* Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ImageBuildBadRequestException

* @throws Exception\ImageBuildInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function imageBuild($requestBody = null, array $queryParameters = [], array $headerParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ImageBuild($requestBody, $queryParameters, $headerParameters), $fetch);

}

/**

* @param array $queryParameters {

*

* @var int $keep-storage Amount of disk space in bytes to keep for cache

* @var bool $all Remove all types of build cache

* @var string $filters A JSON encoded value of the filters (a `map[string][]string`) to

* process on the list of build cache objects.

*

* Available filters:

*

* - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.

* - `id=<id>`

* - `parent=<id>`

* - `type=<string>`

* - `description=<string>`

* - `inuse`

* - `shared`

* - `private`

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\BuildPruneInternalServerErrorException

*

* @return Model\BuildPrunePostResponse200|\Psr\Http\Message\ResponseInterface|null

*/

public function buildPrune(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\BuildPrune($queryParameters), $fetch);

}

/**

* Pull or import an image.

*

* @param array $queryParameters {

*

* @var string $fromImage Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.

* @var string $fromSrc Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.

* @var string $repo Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.

* @var string $tag Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.

* @var string $message set commit message for imported image

* @var array $changes Apply `Dockerfile` instructions to the image that is created,

* for example: `changes=ENV DEBUG=true`.

* Note that `ENV DEBUG=true` should be URI component encoded.

*

* Supported `Dockerfile` instructions:

* `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`

* @var string $platform Platform in the format os[/arch[/variant]].

*

* When used in combination with the `fromImage` option, the daemon checks

* if the given image is present in the local image cache with the given

* OS and Architecture, and otherwise attempts to pull the image. If the

* option is not set, the host's native OS and Architecture are used.

* If the given image does not exist in the local image cache, the daemon

* attempts to pull the image with the host's native OS and Architecture.

* If the given image does exists in the local image cache, but its OS or

* architecture does not match, a warning is produced.

*

* When used with the `fromSrc` option to import an image from an archive,

* this option sets the platform information for the imported image. If

* the option is not set, the host's native OS and Architecture are used

* for the imported image.

*

* }

*

* @param array $headerParameters {

*

* @var string $X-Registry-Auth A base64url-encoded auth configuration.

*

* Refer to the [authentication section](#section/Authentication) for

* details.

*

* }

*

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ImageCreateNotFoundException

* @throws Exception\ImageCreateInternalServerErrorException

*

* @return \Psr\Http\Message\ResponseInterface|null

*/

public function imageCreate(?string $requestBody = null, array $queryParameters = [], array $headerParameters = [], string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ImageCreate($requestBody, $queryParameters, $headerParameters), $fetch);

}

/**

* Return low-level information about an image.

*

* @param string $name Image name or id

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ImageInspectNotFoundException

* @throws Exception\ImageInspectInternalServerErrorException

*

* @return Model\ImageInspect|\Psr\Http\Message\ResponseInterface|null

*/

public function imageInspect(string $name, string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ImageInspect($name), $fetch);

}

/**

* Return parent layers of an image.

*

* @param string $name Image name or ID

* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)

*

* @throws Exception\ImageHistoryNotFoundException

* @throws Exception\ImageHistoryInternalServerErrorException

*

* @return Model\ImagesNameHistoryGetResponse200Item[]|\Psr\Http\Message\ResponseInterface|null

*/

public function imageHistory(string $name, string $fetch = self::FETCH_OBJECT)

{

return $this->executeEndpoint(new Endpoint\ImageHistory($name), $fetch);

}

/**

* Push an image to a registry.

*

* If you wish to push an image on to a private registry, that image must

* already have a tag which references the registry. For example,

* `registry.example.com/myimage:latest`.

*

* The push is cancelled if the HTTP connection is closed.

*