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

Class InspectPodData

java.lang.Object
io.github.alersrt.pod4j.openapi.model.InspectPodData
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-11-29T01:29:49.168634544+07:00[Asia/Barnaul]", comments="Generator version: 7.7.0") public class InspectPodData extends Object
InspectPodData contains detailed information on a pod's configuration and state. It is used as the output of Inspect on pods.

  • Field Details

  • Constructor Details

    • InspectPodData

      public InspectPodData()

  • Method Details

    • 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 InspectPodData

    • fromJson

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

    • cgroupParent

      public InspectPodData cgroupParent(String cgroupParent)

    • getCgroupParent

      @Nullable public String getCgroupParent()
      CgroupParent is the parent of the pod's Cgroup.
      Returns:
      cgroupParent

    • setCgroupParent

      public void setCgroupParent(String cgroupParent)

    • cgroupPath

      public InspectPodData cgroupPath(String cgroupPath)

    • getCgroupPath

      @Nullable public String getCgroupPath()
      CgroupPath is the path to the pod's Cgroup.
      Returns:
      cgroupPath

    • setCgroupPath

      public void setCgroupPath(String cgroupPath)

    • containers

      public InspectPodData containers(List<@Valid InspectPodContainerInfo> containers)

    • addContainersItem

      public InspectPodData addContainersItem(InspectPodContainerInfo containersItem)

    • getContainers

      @Nullable @Valid public @Valid List<@Valid InspectPodContainerInfo> getContainers()
      Containers gives a brief summary of all containers in the pod and their current status.
      Returns:
      containers

    • setContainers

      public void setContainers(List<@Valid InspectPodContainerInfo> containers)

    • createCgroup

      public InspectPodData createCgroup(Boolean createCgroup)

    • getCreateCgroup

      @Nullable public Boolean getCreateCgroup()
      CreateCgroup is whether this pod will create its own Cgroup to group containers under.
      Returns:
      createCgroup

    • setCreateCgroup

      public void setCreateCgroup(Boolean createCgroup)

    • createCommand

      public InspectPodData createCommand(List<String> createCommand)

    • addCreateCommandItem

      public InspectPodData addCreateCommandItem(String createCommandItem)

    • getCreateCommand

      @Nullable public List<String> getCreateCommand()
      CreateCommand is the full command plus arguments of the process the container has been created with.
      Returns:
      createCommand

    • setCreateCommand

      public void setCreateCommand(List<String> createCommand)

    • createInfra

      public InspectPodData createInfra(Boolean createInfra)

    • getCreateInfra

      @Nullable public Boolean getCreateInfra()
      CreateInfra is whether this pod will create an infra container to share namespaces.
      Returns:
      createInfra

    • setCreateInfra

      public void setCreateInfra(Boolean createInfra)

    • created

      public InspectPodData created(OffsetDateTime created)

    • getCreated

      @Nullable @Valid public @Valid OffsetDateTime getCreated()
      Created is the time when the pod was created.
      Returns:
      created

    • setCreated

      public void setCreated(OffsetDateTime created)

    • exitPolicy

      public InspectPodData exitPolicy(String exitPolicy)

    • getExitPolicy

      @Nullable public String getExitPolicy()
      ExitPolicy of the pod.
      Returns:
      exitPolicy

    • setExitPolicy

      public void setExitPolicy(String exitPolicy)

    • hostname

      public InspectPodData hostname(String hostname)

    • getHostname

      @Nullable public String getHostname()
      Hostname is the hostname that the pod will set.
      Returns:
      hostname

    • setHostname

      public void setHostname(String hostname)

    • id

      public InspectPodData id(String id)

    • getId

      @Nullable public String getId()
      ID is the ID of the pod.
      Returns:
      id

    • setId

      public void setId(String id)

    • infraConfig

      public InspectPodData infraConfig(InspectPodInfraConfig infraConfig)

    • getInfraConfig

      @Nullable @Valid public @Valid InspectPodInfraConfig getInfraConfig()
      Get infraConfig
      Returns:
      infraConfig

    • setInfraConfig

      public void setInfraConfig(InspectPodInfraConfig infraConfig)

    • infraContainerID

      public InspectPodData infraContainerID(String infraContainerID)

    • getInfraContainerID

      @Nullable public String getInfraContainerID()
      InfraContainerID is the ID of the pod's infra container, if one is present.
      Returns:
      infraContainerID

    • setInfraContainerID

      public void setInfraContainerID(String infraContainerID)

    • labels

      public InspectPodData labels(Map<String,String> labels)

    • putLabelsItem

      public InspectPodData putLabelsItem(String key, String labelsItem)

    • getLabels

      @Nullable public Map<String,String> getLabels()
      Labels is a set of key-value labels that have been applied to the pod.
      Returns:
      labels

    • setLabels

      public void setLabels(Map<String,String> labels)

    • lockNumber

      public InspectPodData lockNumber(Integer lockNumber)

    • getLockNumber

      @Nullable public Integer getLockNumber()
      Number of the pod's Libpod lock.
      Returns:
      lockNumber

    • setLockNumber

      public void setLockNumber(Integer lockNumber)

    • name

      public InspectPodData name(String name)

    • getName

      @Nullable public String getName()
      Name is the name of the pod.
      Returns:
      name

    • setName

      public void setName(String name)

    • namespace

      public InspectPodData namespace(String namespace)

    • getNamespace

      @Nullable public String getNamespace()
      Namespace is the Libpod namespace the pod is placed in.
      Returns:
      namespace

    • setNamespace

      public void setNamespace(String namespace)

    • numContainers

      public InspectPodData numContainers(Integer numContainers)

    • getNumContainers

      @Nullable public Integer getNumContainers()
      NumContainers is the number of containers in the pod, including the infra container.
      Returns:
      numContainers

    • setNumContainers

      public void setNumContainers(Integer numContainers)

    • restartPolicy

      public InspectPodData restartPolicy(String restartPolicy)

    • getRestartPolicy

      @Nullable public String getRestartPolicy()
      RestartPolicy of the pod.
      Returns:
      restartPolicy

    • setRestartPolicy

      public void setRestartPolicy(String restartPolicy)

    • sharedNamespaces

      public InspectPodData sharedNamespaces(List<String> sharedNamespaces)

    • addSharedNamespacesItem

      public InspectPodData addSharedNamespacesItem(String sharedNamespacesItem)

    • getSharedNamespaces

      @Nullable public List<String> getSharedNamespaces()
      SharedNamespaces contains a list of namespaces that will be shared by containers within the pod. Can only be set if CreateInfra is true.
      Returns:
      sharedNamespaces

    • setSharedNamespaces

      public void setSharedNamespaces(List<String> sharedNamespaces)

    • state

      public InspectPodData state(String state)

    • getState

      @Nullable public String getState()
      State represents the current state of the pod.
      Returns:
      state

    • setState

      public void setState(String state)

    • blkioWeight

      public InspectPodData blkioWeight(Integer blkioWeight)

    • getBlkioWeight

      @Nullable public Integer getBlkioWeight()
      BlkioWeight contains the blkio weight limit for the pod
      Returns:
      blkioWeight

    • setBlkioWeight

      public void setBlkioWeight(Integer blkioWeight)

    • blkioWeightDevice

      public InspectPodData blkioWeightDevice(List<@Valid InspectBlkioWeightDevice> blkioWeightDevice)

    • addBlkioWeightDeviceItem

      public InspectPodData addBlkioWeightDeviceItem(InspectBlkioWeightDevice blkioWeightDeviceItem)

    • getBlkioWeightDevice

      @Nullable @Valid public @Valid List<@Valid InspectBlkioWeightDevice> getBlkioWeightDevice()
      BlkioWeightDevice contains the blkio weight device limits for the pod
      Returns:
      blkioWeightDevice

    • setBlkioWeightDevice

      public void setBlkioWeightDevice(List<@Valid InspectBlkioWeightDevice> blkioWeightDevice)

    • cpuPeriod

      public InspectPodData cpuPeriod(Integer cpuPeriod)

    • getCpuPeriod

      @Nullable public Integer getCpuPeriod()
      CPUPeriod contains the CPU period of the pod
      Returns:
      cpuPeriod

    • setCpuPeriod

      public void setCpuPeriod(Integer cpuPeriod)

    • cpuQuota

      public InspectPodData cpuQuota(Long cpuQuota)

    • getCpuQuota

      @Nullable public Long getCpuQuota()
      CPUQuota contains the CPU quota of the pod
      Returns:
      cpuQuota

    • setCpuQuota

      public void setCpuQuota(Long cpuQuota)

    • cpuShares

      public InspectPodData cpuShares(Integer cpuShares)

    • getCpuShares

      @Nullable public Integer getCpuShares()
      CPUShares contains the cpu shares for the pod
      Returns:
      cpuShares

    • setCpuShares

      public void setCpuShares(Integer cpuShares)

    • cpusetCpus

      public InspectPodData cpusetCpus(String cpusetCpus)

    • getCpusetCpus

      @Nullable public String getCpusetCpus()
      CPUSetCPUs contains linux specific CPU data for the pod
      Returns:
      cpusetCpus

    • setCpusetCpus

      public void setCpusetCpus(String cpusetCpus)

    • cpusetMems

      public InspectPodData cpusetMems(String cpusetMems)

    • getCpusetMems

      @Nullable public String getCpusetMems()
      CPUSetMems contains linux specific CPU data for the pod
      Returns:
      cpusetMems

    • setCpusetMems

      public void setCpusetMems(String cpusetMems)

    • deviceReadBps

      public InspectPodData deviceReadBps(List<@Valid InspectBlkioThrottleDevice> deviceReadBps)

    • addDeviceReadBpsItem

      public InspectPodData addDeviceReadBpsItem(InspectBlkioThrottleDevice deviceReadBpsItem)

    • getDeviceReadBps

      @Nullable @Valid public @Valid List<@Valid InspectBlkioThrottleDevice> getDeviceReadBps()
      BlkioDeviceReadBps contains the Read/Access limit for the pod's devices
      Returns:
      deviceReadBps

    • setDeviceReadBps

      public void setDeviceReadBps(List<@Valid InspectBlkioThrottleDevice> deviceReadBps)

    • deviceWriteBps

      public InspectPodData deviceWriteBps(List<@Valid InspectBlkioThrottleDevice> deviceWriteBps)

    • addDeviceWriteBpsItem

      public InspectPodData addDeviceWriteBpsItem(InspectBlkioThrottleDevice deviceWriteBpsItem)

    • getDeviceWriteBps

      @Nullable @Valid public @Valid List<@Valid InspectBlkioThrottleDevice> getDeviceWriteBps()
      BlkioDeviceReadBps contains the Read/Access limit for the pod's devices
      Returns:
      deviceWriteBps

    • setDeviceWriteBps

      public void setDeviceWriteBps(List<@Valid InspectBlkioThrottleDevice> deviceWriteBps)

    • devices

      public InspectPodData devices(List<@Valid InspectDevice> devices)

    • addDevicesItem

      public InspectPodData addDevicesItem(InspectDevice devicesItem)

    • getDevices

      @Nullable @Valid public @Valid List<@Valid InspectDevice> getDevices()
      Devices contains the specified host devices
      Returns:
      devices

    • setDevices

      public void setDevices(List<@Valid InspectDevice> devices)

    • memoryLimit

      public InspectPodData memoryLimit(Integer memoryLimit)

    • getMemoryLimit

      @Nullable public Integer getMemoryLimit()
      MemoryLimit contains the specified cgroup memory limit for the pod
      Returns:
      memoryLimit

    • setMemoryLimit

      public void setMemoryLimit(Integer memoryLimit)

    • memorySwap

      public InspectPodData memorySwap(Integer memorySwap)

    • getMemorySwap

      @Nullable public Integer getMemorySwap()
      MemorySwap contains the specified memory swap limit for the pod
      Returns:
      memorySwap

    • setMemorySwap

      public void setMemorySwap(Integer memorySwap)

    • mounts

      public InspectPodData mounts(List<@Valid InspectMount> mounts)

    • addMountsItem

      public InspectPodData addMountsItem(InspectMount mountsItem)

    • getMounts

      @Nullable @Valid public @Valid List<@Valid InspectMount> getMounts()
      Mounts contains volume related information for the pod
      Returns:
      mounts

    • setMounts

      public void setMounts(List<@Valid InspectMount> mounts)

    • securityOpt

      public InspectPodData securityOpt(List<String> securityOpt)

    • addSecurityOptItem

      public InspectPodData addSecurityOptItem(String securityOptItem)

    • getSecurityOpt

      @Nullable public List<String> getSecurityOpt()
      SecurityOpt contains the specified security labels and related SELinux information
      Returns:
      securityOpt

    • setSecurityOpt

      public void setSecurityOpt(List<String> securityOpt)

    • volumesFrom

      public InspectPodData volumesFrom(List<String> volumesFrom)

    • addVolumesFromItem

      public InspectPodData addVolumesFromItem(String volumesFromItem)

    • getVolumesFrom

      @Nullable public List<String> getVolumesFrom()
      VolumesFrom contains the containers that the pod inherits mounts from
      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

    • toJson

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