<?php

declare(strict_types=1);

namespace Docker\API\Model;

class HostConfig extends \ArrayObject

{

/**

* @var array

*/

protected $initialized = [];

public function isInitialized($property): bool

{

return \array_key_exists($property, $this->initialized);

}

/**

* An integer value representing this container's relative CPU weight

* versus other containers.

*

* @var int|null

*/

protected $cpuShares;

/**

* Memory limit in bytes.

*

* @var int|null

*/

protected $memory = 0;

/**

* 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.

*

* @var string|null

*/

protected $cgroupParent;

/**

* Block IO weight (relative weight).

*

* @var int|null

*/

protected $blkioWeight;

/**

* Block IO weight (relative device weight) in the form:

*

* ```

* [{"Path": "device_path", "Weight": weight}]

* ```

*

* @var list<ResourcesBlkioWeightDeviceItem>|null

*/

protected $blkioWeightDevice;

/**

* Limit read rate (bytes per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @var list<ThrottleDevice>|null

*/

protected $blkioDeviceReadBps;

/**

* Limit write rate (bytes per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @var list<ThrottleDevice>|null

*/

protected $blkioDeviceWriteBps;

/**

* Limit read rate (IO per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @var list<ThrottleDevice>|null

*/

protected $blkioDeviceReadIOps;

/**

* Limit write rate (IO per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @var list<ThrottleDevice>|null

*/

protected $blkioDeviceWriteIOps;

/**

* The length of a CPU period in microseconds.

*

* @var int|null

*/

protected $cpuPeriod;

/**

* Microseconds of CPU time that the container can get in a CPU period.

*

* @var int|null

*/

protected $cpuQuota;

/**

* The length of a CPU real-time period in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*

* @var int|null

*/

protected $cpuRealtimePeriod;

/**

* The length of a CPU real-time runtime in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*

* @var int|null

*/

protected $cpuRealtimeRuntime;

/**

* CPUs in which to allow execution (e.g., `0-3`, `0,1`).

*

* @var string|null

*/

protected $cpusetCpus;

/**

* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only

* effective on NUMA systems.

*

* @var string|null

*/

protected $cpusetMems;

/**

* A list of devices to add to the container.

*

* @var list<DeviceMapping>|null

*/

protected $devices;

/**

* a list of cgroup rules to apply to the container.

*

* @var list<string>|null

*/

protected $deviceCgroupRules;

/**

* A list of requests for devices to be sent to device drivers.

*

* @var list<DeviceRequest>|null

*/

protected $deviceRequests;

/**

* 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.

*

* @var int|null

*/

protected $kernelMemoryTCP;

/**

* Memory soft limit in bytes.

*

* @var int|null

*/

protected $memoryReservation;

/**

* Total memory limit (memory + swap). Set as `-1` to enable unlimited

* swap.

*

* @var int|null

*/

protected $memorySwap;

/**

* Tune a container's memory swappiness behavior. Accepts an integer

* between 0 and 100.

*

* @var int|null

*/

protected $memorySwappiness;

/**

* CPU quota in units of 10^-9 CPUs.

*

* @var int|null

*/

protected $nanoCpus;

/**

* Disable OOM Killer for the container.

*

* @var bool|null

*/

protected $oomKillDisable;

/**

* 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.

*

* @var bool|null

*/

protected $init;

/**

* Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`

* to not change.

*

* @var int|null

*/

protected $pidsLimit;

/**

* A list of resource limits to set in the container. For example:

*

* ```

* {"Name": "nofile", "Soft": 1024, "Hard": 2048}

* ```

*

* @var list<ResourcesUlimitsItem>|null

*/

protected $ulimits;

/**

* 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.

*

* @var int|null

*/

protected $cpuCount;

/**

* 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.

*

* @var int|null

*/

protected $cpuPercent;

/**

* Maximum IOps for the container system drive (Windows only).

*

* @var int|null

*/

protected $iOMaximumIOps;

/**

* Maximum IO in bytes per second for the container system drive

* (Windows only).

*

* @var int|null

*/

protected $iOMaximumBandwidth;

/**

* 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`.

*

* @var list<string>|null

*/

protected $binds;

/**

* Path to a file where the container ID is written.

*

* @var string|null

*/

protected $containerIDFile;

/**

* The logging configuration for this container.

*

* @var HostConfigLogConfig|null

*/

protected $logConfig;

/**

* 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.

*

* @var string|null

*/

protected $networkMode;

/**

* 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.

*

* @var array<string, list<PortBinding>>|null

*/

protected $portBindings;

/**

* The behavior to apply when the container exits. The default is not to

* restart.

*

* An ever increasing delay (double the previous delay, starting at 100ms) is

* added before each restart to prevent flooding the server.

*

* @var RestartPolicy|null

*/

protected $restartPolicy;

/**

* Automatically remove the container when the container's process

* exits. This has no effect if `RestartPolicy` is set.

*

* @var bool|null

*/

protected $autoRemove;

/**

* Driver that this container uses to mount volumes.

*

* @var string|null

*/

protected $volumeDriver;

/**

* A list of volumes to inherit from another container, specified in

* the form `<container name>[:<ro|rw>]`.

*

* @var list<string>|null

*/

protected $volumesFrom;

/**

* Specification for mounts to be added to the container.

*

* @var list<Mount>|null

*/

protected $mounts;

/**

* Initial console size, as an `[height, width]` array.

*

* @var list<int>|null

*/

protected $consoleSize;

/**

* Arbitrary non-identifying metadata attached to container and

* provided to the runtime when the container is started.

*

* @var array<string, string>|null

*/

protected $annotations;

/**

* A list of kernel capabilities to add to the container. Conflicts

* with option 'Capabilities'.

*

* @var list<string>|null

*/

protected $capAdd;

/**

* A list of kernel capabilities to drop from the container. Conflicts

* with option 'Capabilities'.

*

* @var list<string>|null

*/

protected $capDrop;

/**

* 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.

*

* @var string|null

*/

protected $cgroupnsMode;

/**

* A list of DNS servers for the container to use.

*

* @var list<string>|null

*/

protected $dns;

/**

* A list of DNS options.

*

* @var list<string>|null

*/

protected $dnsOptions;

/**

* A list of DNS search domains.

*

* @var list<string>|null

*/

protected $dnsSearch;

/**

* A list of hostnames/IP mappings to add to the container's `/etc/hosts`

* file. Specified in the form `["hostname:IP"]`.

*

* @var list<string>|null

*/

protected $extraHosts;

/**

* A list of additional groups that the container process will run as.

*

* @var list<string>|null

*/

protected $groupAdd;

/**

* 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.

*

* @var string|null

*/

protected $ipcMode;

/**

* Cgroup to use for the container.

*

* @var string|null

*/

protected $cgroup;

/**

* A list of links for the container in the form `container_name:alias`.

*

* @var list<string>|null

*/

protected $links;

/**

* An integer value containing the score given to the container in

* order to tune OOM killer preferences.

*

* @var int|null

*/

protected $oomScoreAdj;

/**

* 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

*

* @var string|null

*/

protected $pidMode;

/**

* Gives the container full access to the host.

*

* @var bool|null

*/

protected $privileged;

/**

* 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`.

*

* @var bool|null

*/

protected $publishAllPorts;

/**

* Mount the container's root filesystem as read only.

*

* @var bool|null

*/

protected $readonlyRootfs;

/**

* A list of string values to customize labels for MLS systems, such

* as SELinux.

*

* @var list<string>|null

*/

protected $securityOpt;

/**

* Storage driver options for this container, in the form `{"size": "120G"}`.

*

* @var array<string, string>|null

*/

protected $storageOpt;

/**

* 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" }

* ```

*

* @var array<string, string>|null

*/

protected $tmpfs;

/**

* UTS namespace to use for the container.

*

* @var string|null

*/

protected $uTSMode;

/**

* Sets the usernamespace mode for the container when usernamespace

* remapping option is enabled.

*

* @var string|null

*/

protected $usernsMode;

/**

* Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.

*

* @var int|null

*/

protected $shmSize;

/**

* A list of kernel parameters (sysctls) to set in the container.

* For example:

*

* ```

* {"net.ipv4.ip_forward": "1"}

* ```

*

* @var array<string, string>|null

*/

protected $sysctls;

/**

* Runtime to use with this container.

*

* @var string|null

*/

protected $runtime;

/**

* Isolation technology of the container. (Windows only).

*

* @var string|null

*/

protected $isolation;

/**

* The list of paths to be masked inside the container (this overrides

* the default set of paths).

*

* @var list<string>|null

*/

protected $maskedPaths;

/**

* The list of paths to be set as read-only inside the container

* (this overrides the default set of paths).

*

* @var list<string>|null

*/

protected $readonlyPaths;

/**

* An integer value representing this container's relative CPU weight

* versus other containers.

*/

public function getCpuShares(): ?int

{

return $this->cpuShares;

}

/**

* An integer value representing this container's relative CPU weight

* versus other containers.

*/

public function setCpuShares(?int $cpuShares): self

{

$this->initialized['cpuShares'] = true;

$this->cpuShares = $cpuShares;

return $this;

}

/**

* Memory limit in bytes.

*/

public function getMemory(): ?int

{

return $this->memory;

}

/**

* Memory limit in bytes.

*/

public function setMemory(?int $memory): self

{

$this->initialized['memory'] = true;

$this->memory = $memory;

return $this;

}

/**

* 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.

*/

public function getCgroupParent(): ?string

{

return $this->cgroupParent;

}

/**

* 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.

*/

public function setCgroupParent(?string $cgroupParent): self

{

$this->initialized['cgroupParent'] = true;

$this->cgroupParent = $cgroupParent;

return $this;

}

/**

* Block IO weight (relative weight).

*/

public function getBlkioWeight(): ?int

{

return $this->blkioWeight;

}

/**

* Block IO weight (relative weight).

*/

public function setBlkioWeight(?int $blkioWeight): self

{

$this->initialized['blkioWeight'] = true;

$this->blkioWeight = $blkioWeight;

return $this;

}

/**

* Block IO weight (relative device weight) in the form:

*

* ```

* [{"Path": "device_path", "Weight": weight}]

* ```

*

* @return list<ResourcesBlkioWeightDeviceItem>|null

*/

public function getBlkioWeightDevice(): ?array

{

return $this->blkioWeightDevice;

}

/**

* Block IO weight (relative device weight) in the form:

*

* ```

* [{"Path": "device_path", "Weight": weight}]

* ```

*

* @param list<ResourcesBlkioWeightDeviceItem>|null $blkioWeightDevice

*/

public function setBlkioWeightDevice(?array $blkioWeightDevice): self

{

$this->initialized['blkioWeightDevice'] = true;

$this->blkioWeightDevice = $blkioWeightDevice;

return $this;

}

/**

* Limit read rate (bytes per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @return list<ThrottleDevice>|null

*/

public function getBlkioDeviceReadBps(): ?array

{

return $this->blkioDeviceReadBps;

}

/**

* Limit read rate (bytes per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @param list<ThrottleDevice>|null $blkioDeviceReadBps

*/

public function setBlkioDeviceReadBps(?array $blkioDeviceReadBps): self

{

$this->initialized['blkioDeviceReadBps'] = true;

$this->blkioDeviceReadBps = $blkioDeviceReadBps;

return $this;

}

/**

* Limit write rate (bytes per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @return list<ThrottleDevice>|null

*/

public function getBlkioDeviceWriteBps(): ?array

{

return $this->blkioDeviceWriteBps;

}

/**

* Limit write rate (bytes per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @param list<ThrottleDevice>|null $blkioDeviceWriteBps

*/

public function setBlkioDeviceWriteBps(?array $blkioDeviceWriteBps): self

{

$this->initialized['blkioDeviceWriteBps'] = true;

$this->blkioDeviceWriteBps = $blkioDeviceWriteBps;

return $this;

}

/**

* Limit read rate (IO per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @return list<ThrottleDevice>|null

*/

public function getBlkioDeviceReadIOps(): ?array

{

return $this->blkioDeviceReadIOps;

}

/**

* Limit read rate (IO per second) from a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @param list<ThrottleDevice>|null $blkioDeviceReadIOps

*/

public function setBlkioDeviceReadIOps(?array $blkioDeviceReadIOps): self

{

$this->initialized['blkioDeviceReadIOps'] = true;

$this->blkioDeviceReadIOps = $blkioDeviceReadIOps;

return $this;

}

/**

* Limit write rate (IO per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @return list<ThrottleDevice>|null

*/

public function getBlkioDeviceWriteIOps(): ?array

{

return $this->blkioDeviceWriteIOps;

}

/**

* Limit write rate (IO per second) to a device, in the form:

*

* ```

* [{"Path": "device_path", "Rate": rate}]

* ```

*

* @param list<ThrottleDevice>|null $blkioDeviceWriteIOps

*/

public function setBlkioDeviceWriteIOps(?array $blkioDeviceWriteIOps): self

{

$this->initialized['blkioDeviceWriteIOps'] = true;

$this->blkioDeviceWriteIOps = $blkioDeviceWriteIOps;

return $this;

}

/**

* The length of a CPU period in microseconds.

*/

public function getCpuPeriod(): ?int

{

return $this->cpuPeriod;

}

/**

* The length of a CPU period in microseconds.

*/

public function setCpuPeriod(?int $cpuPeriod): self

{

$this->initialized['cpuPeriod'] = true;

$this->cpuPeriod = $cpuPeriod;

return $this;

}

/**

* Microseconds of CPU time that the container can get in a CPU period.

*/

public function getCpuQuota(): ?int

{

return $this->cpuQuota;

}

/**

* Microseconds of CPU time that the container can get in a CPU period.

*/

public function setCpuQuota(?int $cpuQuota): self

{

$this->initialized['cpuQuota'] = true;

$this->cpuQuota = $cpuQuota;

return $this;

}

/**

* The length of a CPU real-time period in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*/

public function getCpuRealtimePeriod(): ?int

{

return $this->cpuRealtimePeriod;

}

/**

* The length of a CPU real-time period in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*/

public function setCpuRealtimePeriod(?int $cpuRealtimePeriod): self

{

$this->initialized['cpuRealtimePeriod'] = true;

$this->cpuRealtimePeriod = $cpuRealtimePeriod;

return $this;

}

/**

* The length of a CPU real-time runtime in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*/

public function getCpuRealtimeRuntime(): ?int

{

return $this->cpuRealtimeRuntime;

}

/**

* The length of a CPU real-time runtime in microseconds. Set to 0 to

* allocate no time allocated to real-time tasks.

*/

public function setCpuRealtimeRuntime(?int $cpuRealtimeRuntime): self

{

$this->initialized['cpuRealtimeRuntime'] = true;

$this->cpuRealtimeRuntime = $cpuRealtimeRuntime;

return $this;

}

/**

* CPUs in which to allow execution (e.g., `0-3`, `0,1`).

*/

public function getCpusetCpus(): ?string

{

return $this->cpusetCpus;

}

/**

* CPUs in which to allow execution (e.g., `0-3`, `0,1`).

*/

public function setCpusetCpus(?string $cpusetCpus): self

{

$this->initialized['cpusetCpus'] = true;

$this->cpusetCpus = $cpusetCpus;

return $this;

}

/**

* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only

* effective on NUMA systems.

*/

public function getCpusetMems(): ?string

{

return $this->cpusetMems;

}

/**

* Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only

* effective on NUMA systems.

*/

public function setCpusetMems(?string $cpusetMems): self

{

$this->initialized['cpusetMems'] = true;

$this->cpusetMems = $cpusetMems;

return $this;

}

/**

* A list of devices to add to the container.

*

* @return list<DeviceMapping>|null

*/

public function getDevices(): ?array

{

return $this->devices;

}

/**

* A list of devices to add to the container.

*

* @param list<DeviceMapping>|null $devices

*/

public function setDevices(?array $devices): self

{

$this->initialized['devices'] = true;

$this->devices = $devices;

return $this;

}

/**

* a list of cgroup rules to apply to the container.

*

* @return list<string>|null

*/

public function getDeviceCgroupRules(): ?array

{

return $this->deviceCgroupRules;

}

/**

* a list of cgroup rules to apply to the container.

*

* @param list<string>|null $deviceCgroupRules

*/

public function setDeviceCgroupRules(?array $deviceCgroupRules): self

{

$this->initialized['deviceCgroupRules'] = true;

$this->deviceCgroupRules = $deviceCgroupRules;

return $this;

}

/**

* A list of requests for devices to be sent to device drivers.

*

* @return list<DeviceRequest>|null

*/

public function getDeviceRequests(): ?array

{

return $this->deviceRequests;

}