Package io.github.alersrt.pod4j.openapi.model

Class InspectContainerHostConfig

java.lang.Object
io.github.alersrt.pod4j.openapi.model.InspectContainerHostConfig
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-11-19T11:19:05.435500352+07:00[Asia/Barnaul]", comments="Generator version: 7.7.0") public class InspectContainerHostConfig extends Object
nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed.

  • Field Details

  • Constructor Details

    • InspectContainerHostConfig

      public InspectContainerHostConfig()

  • Method Details

    • annotations

      public InspectContainerHostConfig annotations(Map<String,String> annotations)

    • putAnnotationsItem

      public InspectContainerHostConfig putAnnotationsItem(String key, String annotationsItem)

    • getAnnotations

      @Nullable public Map<String,String> getAnnotations()
      Annotations are provided to the runtime when the container is started.
      Returns:
      annotations

    • setAnnotations

      public void setAnnotations(Map<String,String> annotations)

    • autoRemove

      public InspectContainerHostConfig autoRemove(Boolean autoRemove)

    • getAutoRemove

      @Nullable public Boolean getAutoRemove()
      AutoRemove is whether the container will be automatically removed on exiting. It is not handled directly within libpod and is stored in an annotation.
      Returns:
      autoRemove

    • setAutoRemove

      public void setAutoRemove(Boolean autoRemove)

    • autoRemoveImage

      public InspectContainerHostConfig autoRemoveImage(Boolean autoRemoveImage)

    • getAutoRemoveImage

      @Nullable public Boolean getAutoRemoveImage()
      AutoRemoveImage is whether the container's image will be automatically removed on exiting. It is not handled directly within libpod and is stored in an annotation.
      Returns:
      autoRemoveImage

    • setAutoRemoveImage

      public void setAutoRemoveImage(Boolean autoRemoveImage)

    • binds

      public InspectContainerHostConfig binds(List<String> binds)

    • addBindsItem

      public InspectContainerHostConfig addBindsItem(String bindsItem)

    • getBinds

      @Nullable public List<String> getBinds()
      Binds contains an array of user-added mounts. Both volume mounts and named volumes are included. Tmpfs mounts are NOT included. In 'docker inspect' this is separated into 'Binds' and 'Mounts' based on how a mount was added. We do not make this distinction and do not include a Mounts field in inspect. Format: <src>:<destination>[:<comma-separated options>]
      Returns:
      binds

    • setBinds

      public void setBinds(List<String> binds)

    • blkioDeviceReadBps

      public InspectContainerHostConfig blkioDeviceReadBps(List<InspectBlkioThrottleDevice> blkioDeviceReadBps)

    • addBlkioDeviceReadBpsItem

      public InspectContainerHostConfig addBlkioDeviceReadBpsItem(InspectBlkioThrottleDevice blkioDeviceReadBpsItem)

    • getBlkioDeviceReadBps

      @Nullable public List<InspectBlkioThrottleDevice> getBlkioDeviceReadBps()
      BlkioDeviceReadBps is an array of I/O throttle parameters for individual device nodes. This specifically sets read rate cap in bytes per second for device nodes. As with BlkioWeightDevice, we pull the path from /sys/dev, and we don't guarantee the path will be identical to the original (though the node will be).
      Returns:
      blkioDeviceReadBps

    • setBlkioDeviceReadBps

      public void setBlkioDeviceReadBps(List<InspectBlkioThrottleDevice> blkioDeviceReadBps)

    • blkioDeviceReadIOps

      public InspectContainerHostConfig blkioDeviceReadIOps(List<InspectBlkioThrottleDevice> blkioDeviceReadIOps)

    • addBlkioDeviceReadIOpsItem

      public InspectContainerHostConfig addBlkioDeviceReadIOpsItem(InspectBlkioThrottleDevice blkioDeviceReadIOpsItem)

    • getBlkioDeviceReadIOps

      @Nullable public List<InspectBlkioThrottleDevice> getBlkioDeviceReadIOps()
      BlkioDeviceReadIOps is an array of I/O throttle parameters for individual device nodes. This specifically sets the read rate cap in iops per second for device nodes. As with BlkioWeightDevice, we pull the path from /sys/dev, and we don't guarantee the path will be identical to the original (though the node will be).
      Returns:
      blkioDeviceReadIOps

    • setBlkioDeviceReadIOps

      public void setBlkioDeviceReadIOps(List<InspectBlkioThrottleDevice> blkioDeviceReadIOps)

    • blkioDeviceWriteBps

      public InspectContainerHostConfig blkioDeviceWriteBps(List<InspectBlkioThrottleDevice> blkioDeviceWriteBps)

    • addBlkioDeviceWriteBpsItem

      public InspectContainerHostConfig addBlkioDeviceWriteBpsItem(InspectBlkioThrottleDevice blkioDeviceWriteBpsItem)

    • getBlkioDeviceWriteBps

      @Nullable public List<InspectBlkioThrottleDevice> getBlkioDeviceWriteBps()
      BlkioDeviceWriteBps is an array of I/O throttle parameters for individual device nodes. this specifically sets write rate cap in bytes per second for device nodes. as with BlkioWeightDevice, we pull the path from /sys/dev, and we don't guarantee the path will be identical to the original (though the node will be).
      Returns:
      blkioDeviceWriteBps

    • setBlkioDeviceWriteBps

      public void setBlkioDeviceWriteBps(List<InspectBlkioThrottleDevice> blkioDeviceWriteBps)

    • blkioDeviceWriteIOps

      public InspectContainerHostConfig blkioDeviceWriteIOps(List<InspectBlkioThrottleDevice> blkioDeviceWriteIOps)

    • addBlkioDeviceWriteIOpsItem

      public InspectContainerHostConfig addBlkioDeviceWriteIOpsItem(InspectBlkioThrottleDevice blkioDeviceWriteIOpsItem)

    • getBlkioDeviceWriteIOps

      @Nullable public List<InspectBlkioThrottleDevice> getBlkioDeviceWriteIOps()
      BlkioDeviceWriteIOps is an array of I/O throttle parameters for individual device nodes. This specifically sets the write rate cap in iops per second for device nodes. As with BlkioWeightDevice, we pull the path from /sys/dev, and we don't guarantee the path will be identical to the original (though the node will be).
      Returns:
      blkioDeviceWriteIOps

    • setBlkioDeviceWriteIOps

      public void setBlkioDeviceWriteIOps(List<InspectBlkioThrottleDevice> blkioDeviceWriteIOps)

    • blkioWeight

      public InspectContainerHostConfig blkioWeight(Integer blkioWeight)

    • getBlkioWeight

      @Nullable public Integer getBlkioWeight()
      BlkioWeight indicates the I/O resources allocated to the container. It is a relative weight in the scheduler for assigning I/O time versus other Cgroups.
      Returns:
      blkioWeight

    • setBlkioWeight

      public void setBlkioWeight(Integer blkioWeight)

    • blkioWeightDevice

      public InspectContainerHostConfig blkioWeightDevice(List<InspectBlkioWeightDevice> blkioWeightDevice)

    • addBlkioWeightDeviceItem

      public InspectContainerHostConfig addBlkioWeightDeviceItem(InspectBlkioWeightDevice blkioWeightDeviceItem)

    • getBlkioWeightDevice

      @Nullable public List<InspectBlkioWeightDevice> getBlkioWeightDevice()
      BlkioWeightDevice is an array of I/O resource priorities for individual device nodes. Unfortunately, the spec only stores the device's Major/Minor numbers and not the path, which is used here. Fortunately, the kernel provides an interface for retrieving the path of a given node by major:minor at /sys/dev/. However, the exact path in use may not be what was used in the original CLI invocation - though it is guaranteed that the device node will be the same, and using the given path will be functionally identical.
      Returns:
      blkioWeightDevice

    • setBlkioWeightDevice

      public void setBlkioWeightDevice(List<InspectBlkioWeightDevice> blkioWeightDevice)

    • capAdd

      public InspectContainerHostConfig capAdd(List<String> capAdd)

    • addCapAddItem

      public InspectContainerHostConfig addCapAddItem(String capAddItem)

    • getCapAdd

      @Nullable public List<String> getCapAdd()
      CapAdd is a list of capabilities added to the container. It is not directly stored by Libpod, and instead computed from the capabilities listed in the container's spec, compared against a set of default capabilities.
      Returns:
      capAdd

    • setCapAdd

      public void setCapAdd(List<String> capAdd)

    • capDrop

      public InspectContainerHostConfig capDrop(List<String> capDrop)

    • addCapDropItem

      public InspectContainerHostConfig addCapDropItem(String capDropItem)

    • getCapDrop

      @Nullable public List<String> getCapDrop()
      CapDrop is a list of capabilities removed from the container. It is not directly stored by libpod, and instead computed from the capabilities listed in the container's spec, compared against a set of default capabilities.
      Returns:
      capDrop

    • setCapDrop

      public void setCapDrop(List<String> capDrop)

    • cgroup

      public InspectContainerHostConfig cgroup(String cgroup)

    • getCgroup

      @Nullable public String getCgroup()
      Cgroup contains the container's cgroup. It is presently not populated. TODO.
      Returns:
      cgroup

    • setCgroup

      public void setCgroup(String cgroup)

    • cgroupConf

      public InspectContainerHostConfig cgroupConf(Map<String,String> cgroupConf)

    • putCgroupConfItem

      public InspectContainerHostConfig putCgroupConfItem(String key, String cgroupConfItem)

    • getCgroupConf

      @Nullable public Map<String,String> getCgroupConf()
      CgroupConf is the configuration for cgroup v2.
      Returns:
      cgroupConf

    • setCgroupConf

      public void setCgroupConf(Map<String,String> cgroupConf)

    • cgroupManager

      public InspectContainerHostConfig cgroupManager(String cgroupManager)

    • getCgroupManager

      @Nullable public String getCgroupManager()
      CgroupManager is the cgroup manager used by the container. At present, allowed values are either \"cgroupfs\" or \"systemd\".
      Returns:
      cgroupManager

    • setCgroupManager

      public void setCgroupManager(String cgroupManager)

    • cgroupMode

      public InspectContainerHostConfig cgroupMode(String cgroupMode)

    • getCgroupMode

      @Nullable public String getCgroupMode()
      CgroupMode is the configuration of the container's cgroup namespace. Populated as follows: private - a cgroup namespace has been created host - No cgroup namespace created container:<id> - Using another container's cgroup namespace ns:<path> - A path to a cgroup namespace has been specified
      Returns:
      cgroupMode

    • setCgroupMode

      public void setCgroupMode(String cgroupMode)

    • cgroupParent

      public InspectContainerHostConfig cgroupParent(String cgroupParent)

    • getCgroupParent

      @Nullable public String getCgroupParent()
      CgroupParent is the Cgroup parent of the container. Only set if not default.
      Returns:
      cgroupParent

    • setCgroupParent

      public void setCgroupParent(String cgroupParent)

    • cgroups

      public InspectContainerHostConfig cgroups(String cgroups)

    • getCgroups

      @Nullable public String getCgroups()
      Cgroups contains the container's Cgroup mode. Allowed values are \"default\" (container is creating Cgroups) and \"disabled\" (container is not creating Cgroups). This is Libpod-specific and not included in `docker inspect`.
      Returns:
      cgroups

    • setCgroups

      public void setCgroups(String cgroups)

    • consoleSize

      public InspectContainerHostConfig consoleSize(List<Integer> consoleSize)

    • addConsoleSizeItem

      public InspectContainerHostConfig addConsoleSizeItem(Integer consoleSizeItem)

    • getConsoleSize

      @Nullable public List<Integer> getConsoleSize()
      ConsoleSize is an array of 2 integers showing the size of the container's console. It is only set if the container is creating a terminal. TODO.
      Returns:
      consoleSize

    • setConsoleSize

      public void setConsoleSize(List<Integer> consoleSize)

    • containerIDFile

      public InspectContainerHostConfig containerIDFile(String containerIDFile)

    • getContainerIDFile

      @Nullable public String getContainerIDFile()
      ContainerIDFile is a file created during container creation to hold the ID of the created container. This is not handled within libpod and is stored in an annotation.
      Returns:
      containerIDFile

    • setContainerIDFile

      public void setContainerIDFile(String containerIDFile)

    • cpuCount

      public InspectContainerHostConfig cpuCount(Integer cpuCount)

    • getCpuCount

      @Nullable public Integer getCpuCount()
      CpuCount is Windows-only and not presently implemented.
      Returns:
      cpuCount

    • setCpuCount

      public void setCpuCount(Integer cpuCount)

    • cpuPercent

      public InspectContainerHostConfig cpuPercent(Integer cpuPercent)

    • getCpuPercent

      @Nullable public Integer getCpuPercent()
      CpuPercent is Windows-only and not presently implemented.
      Returns:
      cpuPercent

    • setCpuPercent

      public void setCpuPercent(Integer cpuPercent)

    • cpuPeriod

      public InspectContainerHostConfig cpuPeriod(Integer cpuPeriod)

    • getCpuPeriod

      @Nullable public Integer getCpuPeriod()
      CpuPeriod is the length of a CPU period in microseconds. It relates directly to CpuQuota.
      Returns:
      cpuPeriod

    • setCpuPeriod

      public void setCpuPeriod(Integer cpuPeriod)

    • cpuQuota

      public InspectContainerHostConfig cpuQuota(Long cpuQuota)

    • getCpuQuota

      @Nullable public Long getCpuQuota()
      CpuPeriod is the amount of time (in microseconds) that a container can use the CPU in every CpuPeriod.
      Returns:
      cpuQuota

    • setCpuQuota

      public void setCpuQuota(Long cpuQuota)

    • cpuRealtimePeriod

      public InspectContainerHostConfig cpuRealtimePeriod(Integer cpuRealtimePeriod)

    • getCpuRealtimePeriod

      @Nullable public Integer getCpuRealtimePeriod()
      CpuRealtimePeriod is the length of time (in microseconds) of the CPU realtime period. If set to 0, no time will be allocated to realtime tasks.
      Returns:
      cpuRealtimePeriod

    • setCpuRealtimePeriod

      public void setCpuRealtimePeriod(Integer cpuRealtimePeriod)

    • cpuRealtimeRuntime

      public InspectContainerHostConfig cpuRealtimeRuntime(Long cpuRealtimeRuntime)

    • getCpuRealtimeRuntime

      @Nullable public Long getCpuRealtimeRuntime()
      CpuRealtimeRuntime is the length of time (in microseconds) allocated for realtime tasks within every CpuRealtimePeriod.
      Returns:
      cpuRealtimeRuntime

    • setCpuRealtimeRuntime

      public void setCpuRealtimeRuntime(Long cpuRealtimeRuntime)

    • cpuShares

      public InspectContainerHostConfig cpuShares(Integer cpuShares)

    • getCpuShares

      @Nullable public Integer getCpuShares()
      CpuShares indicates the CPU resources allocated to the container. It is a relative weight in the scheduler for assigning CPU time versus other Cgroups.
      Returns:
      cpuShares

    • setCpuShares

      public void setCpuShares(Integer cpuShares)

    • cpusetCpus

      public InspectContainerHostConfig cpusetCpus(String cpusetCpus)

    • getCpusetCpus

      @Nullable public String getCpusetCpus()
      CpusetCpus is the set of CPUs that the container will execute on. Formatted as `0-3` or `0,2`. Default (if unset) is all CPUs.
      Returns:
      cpusetCpus

    • setCpusetCpus

      public void setCpusetCpus(String cpusetCpus)

    • cpusetMems

      public InspectContainerHostConfig cpusetMems(String cpusetMems)

    • getCpusetMems

      @Nullable public String getCpusetMems()
      CpusetMems is the set of memory nodes the container will use. Formatted as `0-3` or `0,2`. Default (if unset) is all memory nodes.
      Returns:
      cpusetMems

    • setCpusetMems

      public void setCpusetMems(String cpusetMems)

    • devices

      public InspectContainerHostConfig devices(List<InspectDevice> devices)

    • addDevicesItem

      public InspectContainerHostConfig addDevicesItem(InspectDevice devicesItem)

    • getDevices

      @Nullable public List<InspectDevice> getDevices()
      Devices is a list of device nodes that will be added to the container. These are stored in the OCI spec only as type, major, minor while we display the host path. We convert this with /sys/dev, but we cannot guarantee that the host path will be identical - only that the actual device will be.
      Returns:
      devices

    • setDevices

      public void setDevices(List<InspectDevice> devices)

    • diskQuota

      public InspectContainerHostConfig diskQuota(Integer diskQuota)

    • getDiskQuota

      @Nullable public Integer getDiskQuota()
      DiskQuota is the maximum amount of disk space the container may use (in bytes). Presently not populated. TODO.
      Returns:
      diskQuota

    • setDiskQuota

      public void setDiskQuota(Integer diskQuota)

    • dns

      public InspectContainerHostConfig dns(List<String> dns)

    • addDnsItem

      public InspectContainerHostConfig addDnsItem(String dnsItem)

    • getDns

      @Nullable public List<String> getDns()
      Dns is a list of DNS nameservers that will be added to the container's resolv.conf
      Returns:
      dns

    • setDns

      public void setDns(List<String> dns)

    • dnsOptions

      public InspectContainerHostConfig dnsOptions(List<String> dnsOptions)

    • addDnsOptionsItem

      public InspectContainerHostConfig addDnsOptionsItem(String dnsOptionsItem)

    • getDnsOptions

      @Nullable public List<String> getDnsOptions()
      DnsOptions is a list of DNS options that will be set in the container's resolv.conf
      Returns:
      dnsOptions

    • setDnsOptions

      public void setDnsOptions(List<String> dnsOptions)

    • dnsSearch

      public InspectContainerHostConfig dnsSearch(List<String> dnsSearch)

    • addDnsSearchItem

      public InspectContainerHostConfig addDnsSearchItem(String dnsSearchItem)

    • getDnsSearch

      @Nullable public List<String> getDnsSearch()
      DnsSearch is a list of DNS search domains that will be set in the container's resolv.conf
      Returns:
      dnsSearch

    • setDnsSearch

      public void setDnsSearch(List<String> dnsSearch)

    • extraHosts

      public InspectContainerHostConfig extraHosts(List<String> extraHosts)

    • addExtraHostsItem

      public InspectContainerHostConfig addExtraHostsItem(String extraHostsItem)

    • getExtraHosts

      @Nullable public List<String> getExtraHosts()
      ExtraHosts contains hosts that will be added to the container's etc/hosts.
      Returns:
      extraHosts

    • setExtraHosts

      public void setExtraHosts(List<String> extraHosts)

    • groupAdd

      public InspectContainerHostConfig groupAdd(List<String> groupAdd)

    • addGroupAddItem

      public InspectContainerHostConfig addGroupAddItem(String groupAddItem)

    • getGroupAdd

      @Nullable public List<String> getGroupAdd()
      GroupAdd contains groups that the user inside the container will be added to.
      Returns:
      groupAdd

    • setGroupAdd

      public void setGroupAdd(List<String> groupAdd)

    • idMappings

      public InspectContainerHostConfig idMappings(InspectIDMappings idMappings)

    • getIdMappings

      @Nullable public InspectIDMappings getIdMappings()
      Get idMappings
      Returns:
      idMappings

    • setIdMappings

      public void setIdMappings(InspectIDMappings idMappings)

    • ioMaximumBandwidth

      public InspectContainerHostConfig ioMaximumBandwidth(Integer ioMaximumBandwidth)

    • getIoMaximumBandwidth

      @Nullable public Integer getIoMaximumBandwidth()
      IOMaximumBandwidth is Windows-only and not presently implemented.
      Returns:
      ioMaximumBandwidth

    • setIoMaximumBandwidth

      public void setIoMaximumBandwidth(Integer ioMaximumBandwidth)

    • ioMaximumIOps

      public InspectContainerHostConfig ioMaximumIOps(Integer ioMaximumIOps)

    • getIoMaximumIOps

      @Nullable public Integer getIoMaximumIOps()
      IOMaximumIOps is Windows-only and not presently implemented.
      Returns:
      ioMaximumIOps

    • setIoMaximumIOps

      public void setIoMaximumIOps(Integer ioMaximumIOps)

    • init

      public InspectContainerHostConfig init(Boolean init)

    • getInit

      @Nullable public Boolean getInit()
      Init indicates whether the container has an init mounted into it.
      Returns:
      init

    • setInit

      public void setInit(Boolean init)

    • intelRdtClosID

      public InspectContainerHostConfig intelRdtClosID(String intelRdtClosID)

    • getIntelRdtClosID

      @Nullable public String getIntelRdtClosID()
      IntelRdtClosID defines the Intel RDT CAT Class Of Service (COS) that all processes of the container should run in.
      Returns:
      intelRdtClosID

    • setIntelRdtClosID

      public void setIntelRdtClosID(String intelRdtClosID)

    • ipcMode

      public InspectContainerHostConfig ipcMode(String ipcMode)

    • getIpcMode

      @Nullable public String getIpcMode()
      IpcMode represents the configuration of the container's IPC namespace. Populated as follows: \"\" (empty string) - Default, an IPC namespace will be created host - No IPC namespace created container:<id> - Using another container's IPC namespace ns:<path> - A path to an IPC namespace has been specified
      Returns:
      ipcMode

    • setIpcMode

      public void setIpcMode(String ipcMode)

    • isolation

      public InspectContainerHostConfig isolation(String isolation)

    • getIsolation

      @Nullable public String getIsolation()
      Isolation is presently unused and provided solely for Docker compatibility.
      Returns:
      isolation

    • setIsolation

      public void setIsolation(String isolation)

    • kernelMemory

      public InspectContainerHostConfig kernelMemory(Long kernelMemory)

    • getKernelMemory

      @Nullable public Long getKernelMemory()
      KernelMemory is the maximum amount of memory the kernel will devote to the container.
      Returns:
      kernelMemory

    • setKernelMemory

      public void setKernelMemory(Long kernelMemory)

    • links

      public InspectContainerHostConfig links(List<String> links)

    • addLinksItem

      public InspectContainerHostConfig addLinksItem(String linksItem)

    • getLinks

      @Nullable public List<String> getLinks()
      Links is unused, and provided purely for Docker compatibility.
      Returns:
      links

    • setLinks

      public void setLinks(List<String> links)

    • logConfig

      public InspectContainerHostConfig logConfig(InspectLogConfig logConfig)

    • getLogConfig

      @Nullable public InspectLogConfig getLogConfig()
      Get logConfig
      Returns:
      logConfig

    • setLogConfig

      public void setLogConfig(InspectLogConfig logConfig)

    • memory

      public InspectContainerHostConfig memory(Long memory)

    • getMemory

      @Nullable public Long getMemory()
      Memory indicates the memory resources allocated to the container. This is the limit (in bytes) of RAM the container may use.
      Returns:
      memory

    • setMemory

      public void setMemory(Long memory)

    • memoryReservation

      public InspectContainerHostConfig memoryReservation(Long memoryReservation)

    • getMemoryReservation

      @Nullable public Long getMemoryReservation()
      MemoryReservation is the reservation (soft limit) of memory available to the container. Soft limits are warnings only and can be exceeded.
      Returns:
      memoryReservation

    • setMemoryReservation

      public void setMemoryReservation(Long memoryReservation)

    • memorySwap

      public InspectContainerHostConfig memorySwap(Long memorySwap)

    • getMemorySwap

      @Nullable public Long getMemorySwap()
      MemorySwap is the total limit for all memory available to the container, including swap. 0 indicates that there is no limit to the amount of memory available.
      Returns:
      memorySwap

    • setMemorySwap

      public void setMemorySwap(Long memorySwap)

    • memorySwappiness

      public InspectContainerHostConfig memorySwappiness(Long memorySwappiness)

    • getMemorySwappiness

      @Nullable public Long getMemorySwappiness()
      MemorySwappiness is the willingness of the kernel to page container memory to swap. It is an integer from 0 to 100, with low numbers being more likely to be put into swap. 1, the default, will not set swappiness and use the system defaults.
      Returns:
      memorySwappiness

    • setMemorySwappiness

      public void setMemorySwappiness(Long memorySwappiness)

    • nanoCpus

      public InspectContainerHostConfig nanoCpus(Long nanoCpus)

    • getNanoCpus

      @Nullable public Long getNanoCpus()
      NanoCpus indicates number of CPUs allocated to the container. It is an integer where one full CPU is indicated by 1000000000 (one billion). Thus, 2.5 CPUs (fractional portions of CPUs are allowed) would be 2500000000 (2.5 billion). In 'docker inspect' this is set exclusively of two further options in the output (CpuPeriod and CpuQuota) which are both used to implement this functionality. We can't distinguish here, so if CpuQuota is set to the default of 100000, we will set both CpuQuota, CpuPeriod, and NanoCpus. If CpuQuota is not the default, we will not set NanoCpus.
      Returns:
      nanoCpus

    • setNanoCpus

      public void setNanoCpus(Long nanoCpus)

    • networkMode

      public InspectContainerHostConfig networkMode(String networkMode)

    • getNetworkMode

      @Nullable public String getNetworkMode()
      NetworkMode is the configuration of the container's network namespace. Populated as follows: default - A network namespace is being created and configured via CNI none - A network namespace is being created, not configured via CNI host - No network namespace created container:<id> - Using another container's network namespace ns:<path> - A path to a network namespace has been specified
      Returns:
      networkMode

    • setNetworkMode

      public void setNetworkMode(String networkMode)

    • oomKillDisable

      public InspectContainerHostConfig oomKillDisable(Boolean oomKillDisable)

    • getOomKillDisable

      @Nullable public Boolean getOomKillDisable()
      OomKillDisable indicates whether the kernel OOM killer is disabled for the container.
      Returns:
      oomKillDisable

    • setOomKillDisable

      public void setOomKillDisable(Boolean oomKillDisable)

    • oomScoreAdj

      public InspectContainerHostConfig oomScoreAdj(Long oomScoreAdj)

    • getOomScoreAdj

      @Nullable public Long getOomScoreAdj()
      OOMScoreAdj is an adjustment that will be made to the container's OOM score.
      Returns:
      oomScoreAdj

    • setOomScoreAdj

      public void setOomScoreAdj(Long oomScoreAdj)

    • pidMode

      public InspectContainerHostConfig pidMode(String pidMode)

    • getPidMode

      @Nullable public String getPidMode()
      PidMode represents the configuration of the container's PID namespace. Populated as follows: \"\" (empty string) - Default, a PID namespace will be created host - No PID namespace created container:<id> - Using another container's PID namespace ns:<path> - A path to a PID namespace has been specified
      Returns:
      pidMode

    • setPidMode

      public void setPidMode(String pidMode)

    • pidsLimit

      public InspectContainerHostConfig pidsLimit(Long pidsLimit)

    • getPidsLimit

      @Nullable public Long getPidsLimit()
      PidsLimit is the maximum number of PIDs that may be created within the container. 0, the default, indicates no limit.
      Returns:
      pidsLimit

    • setPidsLimit

      public void setPidsLimit(Long pidsLimit)

    • portBindings

      public InspectContainerHostConfig portBindings(Map<String,List<InspectHostPort>> portBindings)

    • putPortBindingsItem

      public InspectContainerHostConfig putPortBindingsItem(String key, List<InspectHostPort> portBindingsItem)

    • getPortBindings

      @Nullable public Map<String,List<InspectHostPort>> getPortBindings()
      PortBindings contains the container's port bindings. It is formatted as map[string][]InspectHostPort. The string key here is formatted as <integer port number>/<protocol> and represents the container port. A single container port may be bound to multiple host ports (on different IPs).
      Returns:
      portBindings

    • setPortBindings

      public void setPortBindings(Map<String,List<InspectHostPort>> portBindings)

    • privileged

      public InspectContainerHostConfig privileged(Boolean privileged)

    • getPrivileged

      @Nullable public Boolean getPrivileged()
      Privileged indicates whether the container is running with elevated privileges. This has a very specific meaning in the Docker sense, so it's very difficult to decode from the spec and config, and so is stored as an annotation.
      Returns:
      privileged

    • setPrivileged

      public void setPrivileged(Boolean privileged)

    • publishAllPorts

      public InspectContainerHostConfig publishAllPorts(Boolean publishAllPorts)

    • getPublishAllPorts

      @Nullable public Boolean getPublishAllPorts()
      PublishAllPorts indicates whether image ports are being published. This is not directly stored in libpod and is saved as an annotation.
      Returns:
      publishAllPorts

    • setPublishAllPorts

      public void setPublishAllPorts(Boolean publishAllPorts)

    • readonlyRootfs

      public InspectContainerHostConfig readonlyRootfs(Boolean readonlyRootfs)

    • getReadonlyRootfs

      @Nullable public Boolean getReadonlyRootfs()
      ReadonlyRootfs is whether the container will be mounted read-only.
      Returns:
      readonlyRootfs

    • setReadonlyRootfs

      public void setReadonlyRootfs(Boolean readonlyRootfs)

    • restartPolicy

      public InspectContainerHostConfig restartPolicy(InspectRestartPolicy restartPolicy)

    • getRestartPolicy

      @Nullable public InspectRestartPolicy getRestartPolicy()
      Get restartPolicy
      Returns:
      restartPolicy

    • setRestartPolicy

      public void setRestartPolicy(InspectRestartPolicy restartPolicy)

    • runtime

      public InspectContainerHostConfig runtime(String runtime)

    • getRuntime

      @Nullable public String getRuntime()
      Runtime is provided purely for Docker compatibility. It is set unconditionally to \"oci\" as Podman does not presently support non-OCI runtimes.
      Returns:
      runtime

    • setRuntime

      public void setRuntime(String runtime)

    • securityOpt

      public InspectContainerHostConfig securityOpt(List<String> securityOpt)

    • addSecurityOptItem

      public InspectContainerHostConfig addSecurityOptItem(String securityOptItem)

    • getSecurityOpt

      @Nullable public List<String> getSecurityOpt()
      SecurityOpt is a list of security-related options that are set in the container.
      Returns:
      securityOpt

    • setSecurityOpt

      public void setSecurityOpt(List<String> securityOpt)

    • shmSize

      public InspectContainerHostConfig shmSize(Long shmSize)

    • getShmSize

      @Nullable public Long getShmSize()
      Get shmSize
      Returns:
      shmSize

    • setShmSize

      public void setShmSize(Long shmSize)

    • tmpfs

      public InspectContainerHostConfig tmpfs(Map<String,String> tmpfs)

    • putTmpfsItem

      public InspectContainerHostConfig putTmpfsItem(String key, String tmpfsItem)

    • getTmpfs

      @Nullable public Map<String,String> getTmpfs()
      Tmpfs is a list of tmpfs filesystems that will be mounted into the container. It is a map of destination path to options for the mount.
      Returns:
      tmpfs

    • setTmpfs

      public void setTmpfs(Map<String,String> tmpfs)

    • utSMode

      public InspectContainerHostConfig utSMode(String utSMode)

    • getUtSMode

      @Nullable public String getUtSMode()
      UTSMode represents the configuration of the container's UID namespace. Populated as follows: \"\" (empty string) - Default, a UTS namespace will be created host - no UTS namespace created container:<id> - Using another container's UTS namespace ns:<path> - A path to a UTS namespace has been specified
      Returns:
      utSMode

    • setUtSMode

      public void setUtSMode(String utSMode)

    • ulimits

      public InspectContainerHostConfig ulimits(List<InspectUlimit> ulimits)

    • addUlimitsItem

      public InspectContainerHostConfig addUlimitsItem(InspectUlimit ulimitsItem)

    • getUlimits

      @Nullable public List<InspectUlimit> getUlimits()
      Ulimits is a set of ulimits that will be set within the container.
      Returns:
      ulimits

    • setUlimits

      public void setUlimits(List<InspectUlimit> ulimits)

    • usernsMode

      public InspectContainerHostConfig usernsMode(String usernsMode)

    • getUsernsMode

      @Nullable public String getUsernsMode()
      UsernsMode represents the configuration of the container's user namespace. When running rootless, a user namespace is created outside of libpod to allow some privileged operations. This will not be reflected here. Populated as follows: \"\" (empty string) - No user namespace will be created private - The container will be run in a user namespace container:<id> - Using another container's user namespace ns:<path> - A path to a user namespace has been specified TODO Rootless has an additional 'keep-id' option, presently not reflected here.
      Returns:
      usernsMode

    • setUsernsMode

      public void setUsernsMode(String usernsMode)

    • volumeDriver

      public InspectContainerHostConfig volumeDriver(String volumeDriver)

    • getVolumeDriver

      @Nullable public String getVolumeDriver()
      VolumeDriver is presently unused and is retained for Docker compatibility.
      Returns:
      volumeDriver

    • setVolumeDriver

      public void setVolumeDriver(String volumeDriver)

    • volumesFrom

      public InspectContainerHostConfig volumesFrom(List<String> volumesFrom)

    • addVolumesFromItem

      public InspectContainerHostConfig addVolumesFromItem(String volumesFromItem)

    • getVolumesFrom

      @Nullable public List<String> getVolumesFrom()
      VolumesFrom is a list of containers which this container uses volumes from. This is not handled directly within libpod and is stored in an annotation. It is formatted as an array of container names and IDs.
      Returns:
      volumesFrom

    • setVolumesFrom

      public void setVolumesFrom(List<String> volumesFrom)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to InspectContainerHostConfig

    • fromJson

      public static InspectContainerHostConfig fromJson(String jsonString) throws IOException
      Create an instance of InspectContainerHostConfig given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of InspectContainerHostConfig
      Throws:
      IOException - if the JSON string is invalid with respect to InspectContainerHostConfig

    • toJson

      public String toJson()
      Convert an instance of InspectContainerHostConfig to an JSON string
      Returns:
      JSON string