<?php

declare(strict_types=1);

/*

* This file has been auto generated by Jane,

*

* Do no edit it directly.

*/

namespace Docker\API\Model;

class HostConfig

{

/**

* An integer value representing this container's relative CPU weight versus other containers.

*

* @var int

*/

protected $cpuShares;

/**

* Memory limit in bytes.

*

* @var int

*/

protected $memory;

/**

* 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

*/

protected $cgroupParent;

/**

* Block IO weight (relative weight).

*

* @var int

*/

protected $blkioWeight;

/**

* Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.

*

* @var ResourcesBlkioWeightDeviceItem[]

*/

protected $blkioWeightDevice;

/**

* Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @var ThrottleDevice[]

*/

protected $blkioDeviceReadBps;

/**

* Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @var ThrottleDevice[]

*/

protected $blkioDeviceWriteBps;

/**

* Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @var ThrottleDevice[]

*/

protected $blkioDeviceReadIOps;

/**

* Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @var ThrottleDevice[]

*/

protected $blkioDeviceWriteIOps;

/**

* The length of a CPU period in microseconds.

*

* @var int

*/

protected $cpuPeriod;

/**

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

*

* @var int

*/

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

*/

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

*/

protected $cpuRealtimeRuntime;

/**

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

*

* @var string

*/

protected $cpusetCpus;

/**

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

*

* @var string

*/

protected $cpusetMems;

/**

* A list of devices to add to the container.

*

* @var DeviceMapping[]

*/

protected $devices;

/**

* Disk limit (in bytes).

*

* @var int

*/

protected $diskQuota;

/**

* Kernel memory limit in bytes.

*

* @var int

*/

protected $kernelMemory;

/**

* Memory soft limit in bytes.

*

* @var int

*/

protected $memoryReservation;

/**

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

*

* @var int

*/

protected $memorySwap;

/**

* Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

*

* @var int

*/

protected $memorySwappiness;

/**

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

*

* @var int

*/

protected $nanoCPUs;

/**

* Disable OOM Killer for the container.

*

* @var bool

*/

protected $oomKillDisable;

/**

* Tune a container's pids limit. Set -1 for unlimited.

*

* @var int

*/

protected $pidsLimit;

/**

* A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`".

*

* @var ResourcesUlimitsItem[]

*/

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

*/

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

*/

protected $cpuPercent;

/**

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

*

* @var int

*/

protected $iOMaximumIOps;

/**

* Maximum IO in bytes per second for the container system drive (Windows only).

*

* @var int

*/

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` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path.

- `host-src:container-dest:ro` to make the bind-mount read-only inside the container. Both `host-src`, and `container-dest` must be an _absolute_ path.

- `volume-name:container-dest` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path.

- `volume-name:container-dest:ro` to mount the volume read-only inside the container. `container-dest` must be an _absolute_ path.

*

* @var string[]

*/

protected $binds;

/**

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

*

* @var string

*/

protected $containerIDFile;

/**

* The logging configuration for this container.

*

* @var HostConfigLogConfig

*/

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

*/

protected $networkMode;

/**

* A map of exposed container ports and the host port they should map to.

*

* @var HostConfigPortBindingsItem[]

*/

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

*/

protected $restartPolicy;

/**

* Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set.

*

* @var bool

*/

protected $autoRemove;

/**

* Driver that this container uses to mount volumes.

*

* @var string

*/

protected $volumeDriver;

/**

* A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`.

*

* @var string[]

*/

protected $volumesFrom;

/**

* Specification for mounts to be added to the container.

*

* @var Mount[]

*/

protected $mounts;

/**

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

*

* @var string[]

*/

protected $capAdd;

/**

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

*

* @var string[]

*/

protected $capDrop;

/**

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

*

* @var string[]

*/

protected $dns;

/**

* A list of DNS options.

*

* @var string[]

*/

protected $dnsOptions;

/**

* A list of DNS search domains.

*

* @var string[]

*/

protected $dnsSearch;

/**

* A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `["hostname:IP"]`.

*

* @var string[]

*/

protected $extraHosts;

/**

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

*

* @var string[]

*/

protected $groupAdd;

/**

* IPC namespace to use for the container.

*

* @var string

*/

protected $ipcMode;

/**

* Cgroup to use for the container.

*

* @var string

*/

protected $cgroup;

/**

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

*

* @var string[]

*/

protected $links;

/**

* An integer value containing the score given to the container in order to tune OOM killer preferences.

*

* @var int

*/

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

*/

protected $pidMode;

/**

* Gives the container full access to the host.

*

* @var bool

*/

protected $privileged;

/**

* Allocates a random host port for all of a container's exposed ports.

*

* @var bool

*/

protected $publishAllPorts;

/**

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

*

* @var bool

*/

protected $readonlyRootfs;

/**

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

*

* @var string[]

*/

protected $securityOpt;

/**

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

*

* @var string[]

*/

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 string[]

*/

protected $tmpfs;

/**

* UTS namespace to use for the container.

*

* @var string

*/

protected $uTSMode;

/**

* Sets the usernamespace mode for the container when usernamespace remapping option is enabled.

*

* @var string

*/

protected $usernsMode;

/**

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

*

* @var int

*/

protected $shmSize;

/**

* A list of kernel parameters (sysctls) to set in the container. For example: `{"net.ipv4.ip_forward": "1"}`.

*

* @var string[]

*/

protected $sysctls;

/**

* Runtime to use with this container.

*

* @var string

*/

protected $runtime;

/**

* Initial console size, as an `[height, width]` array. (Windows only).

*

* @var int[]

*/

protected $consoleSize;

/**

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

*

* @var string

*/

protected $isolation;

/**

* An integer value representing this container's relative CPU weight versus other containers.

*

* @return int

*/

public function getCpuShares(): ?int

{

return $this->cpuShares;

}

/**

* An integer value representing this container's relative CPU weight versus other containers.

*

* @param int $cpuShares

*

* @return self

*/

public function setCpuShares(?int $cpuShares): self

{

$this->cpuShares = $cpuShares;

return $this;

}

/**

* Memory limit in bytes.

*

* @return int

*/

public function getMemory(): ?int

{

return $this->memory;

}

/**

* Memory limit in bytes.

*

* @param int $memory

*

* @return self

*/

public function setMemory(?int $memory): self

{

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

*

* @return string

*/

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.

*

* @param string $cgroupParent

*

* @return self

*/

public function setCgroupParent(?string $cgroupParent): self

{

$this->cgroupParent = $cgroupParent;

return $this;

}

/**

* Block IO weight (relative weight).

*

* @return int

*/

public function getBlkioWeight(): ?int

{

return $this->blkioWeight;

}

/**

* Block IO weight (relative weight).

*

* @param int $blkioWeight

*

* @return self

*/

public function setBlkioWeight(?int $blkioWeight): self

{

$this->blkioWeight = $blkioWeight;

return $this;

}

/**

* Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.

*

* @return ResourcesBlkioWeightDeviceItem[]

*/

public function getBlkioWeightDevice(): ?array

{

return $this->blkioWeightDevice;

}

/**

* Block IO weight (relative device weight) in the form `[{"Path": "device_path", "Weight": weight}]`.

*

* @param ResourcesBlkioWeightDeviceItem[] $blkioWeightDevice

*

* @return self

*/

public function setBlkioWeightDevice(?array $blkioWeightDevice): self

{

$this->blkioWeightDevice = $blkioWeightDevice;

return $this;

}

/**

* Limit read rate (bytes per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @return ThrottleDevice[]

*/

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 ThrottleDevice[] $blkioDeviceReadBps

*

* @return self

*/

public function setBlkioDeviceReadBps(?array $blkioDeviceReadBps): self

{

$this->blkioDeviceReadBps = $blkioDeviceReadBps;

return $this;

}

/**

* Limit write rate (bytes per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @return ThrottleDevice[]

*/

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 ThrottleDevice[] $blkioDeviceWriteBps

*

* @return self

*/

public function setBlkioDeviceWriteBps(?array $blkioDeviceWriteBps): self

{

$this->blkioDeviceWriteBps = $blkioDeviceWriteBps;

return $this;

}

/**

* Limit read rate (IO per second) from a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @return ThrottleDevice[]

*/

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 ThrottleDevice[] $blkioDeviceReadIOps

*

* @return self

*/

public function setBlkioDeviceReadIOps(?array $blkioDeviceReadIOps): self

{

$this->blkioDeviceReadIOps = $blkioDeviceReadIOps;

return $this;

}

/**

* Limit write rate (IO per second) to a device, in the form `[{"Path": "device_path", "Rate": rate}]`.

*

* @return ThrottleDevice[]

*/

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 ThrottleDevice[] $blkioDeviceWriteIOps

*

* @return self

*/

public function setBlkioDeviceWriteIOps(?array $blkioDeviceWriteIOps): self

{

$this->blkioDeviceWriteIOps = $blkioDeviceWriteIOps;

return $this;

}

/**

* The length of a CPU period in microseconds.

*

* @return int

*/

public function getCpuPeriod(): ?int

{

return $this->cpuPeriod;

}

/**

* The length of a CPU period in microseconds.

*

* @param int $cpuPeriod

*

* @return self

*/

public function setCpuPeriod(?int $cpuPeriod): self

{

$this->cpuPeriod = $cpuPeriod;

return $this;

}

/**

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

*

* @return int

*/

public function getCpuQuota(): ?int

{

return $this->cpuQuota;

}

/**

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

*

* @param int $cpuQuota

*

* @return self

*/

public function setCpuQuota(?int $cpuQuota): self

{

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

*

* @return int

*/

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.

*

* @param int $cpuRealtimePeriod

*

* @return self

*/

public function setCpuRealtimePeriod(?int $cpuRealtimePeriod): self

{

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

*

* @return int

*/

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.

*

* @param int $cpuRealtimeRuntime

*

* @return self

*/

public function setCpuRealtimeRuntime(?int $cpuRealtimeRuntime): self

{

$this->cpuRealtimeRuntime = $cpuRealtimeRuntime;

return $this;

}

/**

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

*

* @return string

*/

public function getCpusetCpus(): ?string

{

return $this->cpusetCpus;

}

/**

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

*

* @param string $cpusetCpus

*

* @return self

*/

public function setCpusetCpus(?string $cpusetCpus): self

{

$this->cpusetCpus = $cpusetCpus;

return $this;

}

/**

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

*

* @return string

*/

public function getCpusetMems(): ?string

{

return $this->cpusetMems;

}

/**

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

*

* @param string $cpusetMems

*

* @return self

*/

public function setCpusetMems(?string $cpusetMems): self

{

$this->cpusetMems = $cpusetMems;

return $this;

}

/**

* A list of devices to add to the container.

*

* @return DeviceMapping[]

*/

public function getDevices(): ?array

{

return $this->devices;

}

/**

* A list of devices to add to the container.

*

* @param DeviceMapping[] $devices

*

* @return self

*/

public function setDevices(?array $devices): self

{

$this->devices = $devices;

return $this;

}

/**

* Disk limit (in bytes).

*

* @return int

*/

public function getDiskQuota(): ?int

{

return $this->diskQuota;

}

/**

* Disk limit (in bytes).

*

* @param int $diskQuota

*

* @return self

*/

public function setDiskQuota(?int $diskQuota): self

{

$this->diskQuota = $diskQuota;

return $this;

}

/**

* Kernel memory limit in bytes.

*

* @return int

*/

public function getKernelMemory(): ?int

{

return $this->kernelMemory;

}

/**

* Kernel memory limit in bytes.

*

* @param int $kernelMemory

*

* @return self

*/

public function setKernelMemory(?int $kernelMemory): self

{

$this->kernelMemory = $kernelMemory;

return $this;

}

/**

* Memory soft limit in bytes.

*

* @return int

*/

public function getMemoryReservation(): ?int

{

return $this->memoryReservation;

}

/**

* Memory soft limit in bytes.

*

* @param int $memoryReservation

*

* @return self

*/

public function setMemoryReservation(?int $memoryReservation): self

{

$this->memoryReservation = $memoryReservation;

return $this;

}

/**

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

*

* @return int

*/

public function getMemorySwap(): ?int

{

return $this->memorySwap;

}

/**

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

*

* @param int $memorySwap

*

* @return self

*/

public function setMemorySwap(?int $memorySwap): self

{

$this->memorySwap = $memorySwap;

return $this;

}

/**

* Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

*

* @return int

*/

public function getMemorySwappiness(): ?int

{

return $this->memorySwappiness;

}

/**

* Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.

*

* @param int $memorySwappiness

*

* @return self

*/

public function setMemorySwappiness(?int $memorySwappiness): self

{

$this->memorySwappiness = $memorySwappiness;

return $this;

}

/**

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

*

* @return int

*/

public function getNanoCPUs(): ?int

{

return $this->nanoCPUs;

}

/**

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

*

* @param int $nanoCPUs

*

* @return self

*/

public function setNanoCPUs(?int $nanoCPUs): self

{

$this->nanoCPUs = $nanoCPUs;

return $this;

}

/**

* Disable OOM Killer for the container.

*

* @return bool

*/

public function getOomKillDisable(): ?bool

{

return $this->oomKillDisable;

}

/**

* Disable OOM Killer for the container.

*

* @param bool $oomKillDisable

*

* @return self

*/

public function setOomKillDisable(?bool $oomKillDisable): self

{

$this->oomKillDisable = $oomKillDisable;

return $this;

}

/**

* Tune a container's pids limit. Set -1 for unlimited.

*

* @return int

*/

public function getPidsLimit(): ?int

{

return $this->pidsLimit;

}

/**

* Tune a container's pids limit. Set -1 for unlimited.

*

* @param int $pidsLimit

*

* @return self

*/

public function setPidsLimit(?int $pidsLimit): self

{

$this->pidsLimit = $pidsLimit;

return $this;

}

/**

* A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`".

*

* @return ResourcesUlimitsItem[]

*/

public function getUlimits(): ?array