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

Class InspectContainerConfig

java.lang.Object
io.github.alersrt.pod4j.openapi.model.InspectContainerConfig
All Implemented Interfaces:
Serializable
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class InspectContainerConfig extends Object implements Serializable
InspectContainerConfig holds further data about how a container was initially configured.
See Also:

  • Field Details

  • Constructor Details

    • InspectContainerConfig

      public InspectContainerConfig()

  • Method Details

    • annotations

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

    • putAnnotationsItem

      public InspectContainerConfig putAnnotationsItem(String key, String annotationsItem)

    • getAnnotations

      @Nullable public Map<String,String> getAnnotations()
      Container annotations
      Returns:
      annotations

    • setAnnotations

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

    • attachStderr

      public InspectContainerConfig attachStderr(Boolean attachStderr)

    • getAttachStderr

      @Nullable public Boolean getAttachStderr()
      Unused, at present
      Returns:
      attachStderr

    • setAttachStderr

      public void setAttachStderr(Boolean attachStderr)

    • attachStdin

      public InspectContainerConfig attachStdin(Boolean attachStdin)

    • getAttachStdin

      @Nullable public Boolean getAttachStdin()
      Unused, at present
      Returns:
      attachStdin

    • setAttachStdin

      public void setAttachStdin(Boolean attachStdin)

    • attachStdout

      public InspectContainerConfig attachStdout(Boolean attachStdout)

    • getAttachStdout

      @Nullable public Boolean getAttachStdout()
      Unused, at present
      Returns:
      attachStdout

    • setAttachStdout

      public void setAttachStdout(Boolean attachStdout)

    • chrootDirs

      public InspectContainerConfig chrootDirs(List<String> chrootDirs)

    • addChrootDirsItem

      public InspectContainerConfig addChrootDirsItem(String chrootDirsItem)

    • getChrootDirs

      @Nullable public List<String> getChrootDirs()
      ChrootDirs is an additional set of directories that need to be treated as root directories. Standard bind mounts will be mounted into paths relative to these directories.
      Returns:
      chrootDirs

    • setChrootDirs

      public void setChrootDirs(List<String> chrootDirs)

    • cmd

      public InspectContainerConfig cmd(List<String> cmd)

    • addCmdItem

      public InspectContainerConfig addCmdItem(String cmdItem)

    • getCmd

      @Nullable public List<String> getCmd()
      Container command
      Returns:
      cmd

    • setCmd

      public void setCmd(List<String> cmd)

    • createCommand

      public InspectContainerConfig createCommand(List<String> createCommand)

    • addCreateCommandItem

      public InspectContainerConfig 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)

    • domainname

      public InspectContainerConfig domainname(String domainname)

    • getDomainname

      @Nullable public String getDomainname()
      Container domain name - unused at present
      Returns:
      domainname

    • setDomainname

      public void setDomainname(String domainname)

    • entrypoint

      public InspectContainerConfig entrypoint(List<String> entrypoint)

    • addEntrypointItem

      public InspectContainerConfig addEntrypointItem(String entrypointItem)

    • getEntrypoint

      @Nullable public List<String> getEntrypoint()
      Container entrypoint
      Returns:
      entrypoint

    • setEntrypoint

      public void setEntrypoint(List<String> entrypoint)

    • env

      public InspectContainerConfig env(List<String> env)

    • addEnvItem

      public InspectContainerConfig addEnvItem(String envItem)

    • getEnv

      @Nullable public List<String> getEnv()
      Container environment variables
      Returns:
      env

    • setEnv

      public void setEnv(List<String> env)

    • exposedPorts

      public InspectContainerConfig exposedPorts(Map<String,Object> exposedPorts)

    • putExposedPortsItem

      public InspectContainerConfig putExposedPortsItem(String key, Object exposedPortsItem)

    • getExposedPorts

      @Nullable public Map<String,Object> getExposedPorts()
      ExposedPorts includes ports the container has exposed.
      Returns:
      exposedPorts

    • setExposedPorts

      public void setExposedPorts(Map<String,Object> exposedPorts)

    • healthLogDestination

      public InspectContainerConfig healthLogDestination(String healthLogDestination)

    • getHealthLogDestination

      @Nullable public String getHealthLogDestination()
      HealthLogDestination defines the destination where the log is stored
      Returns:
      healthLogDestination

    • setHealthLogDestination

      public void setHealthLogDestination(String healthLogDestination)

    • healthcheck

      public InspectContainerConfig healthcheck(Schema2HealthConfig healthcheck)

    • getHealthcheck

      @Nullable @Valid public @Valid Schema2HealthConfig getHealthcheck()
      Get healthcheck
      Returns:
      healthcheck

    • setHealthcheck

      public void setHealthcheck(Schema2HealthConfig healthcheck)

    • healthcheckMaxLogCount

      public InspectContainerConfig healthcheckMaxLogCount(Integer healthcheckMaxLogCount)

    • getHealthcheckMaxLogCount

      @Nullable public Integer getHealthcheckMaxLogCount()
      HealthMaxLogCount is maximum number of attempts in the HealthCheck log file. ('0' value means an infinite number of attempts in the log file)
      Returns:
      healthcheckMaxLogCount

    • setHealthcheckMaxLogCount

      public void setHealthcheckMaxLogCount(Integer healthcheckMaxLogCount)

    • healthcheckMaxLogSize

      public InspectContainerConfig healthcheckMaxLogSize(Integer healthcheckMaxLogSize)

    • getHealthcheckMaxLogSize

      @Nullable public Integer getHealthcheckMaxLogSize()
      HealthMaxLogSize is the maximum length in characters of stored HealthCheck log (\"0\" value means an infinite log length)
      Returns:
      healthcheckMaxLogSize

    • setHealthcheckMaxLogSize

      public void setHealthcheckMaxLogSize(Integer healthcheckMaxLogSize)

    • healthcheckOnFailureAction

      public InspectContainerConfig healthcheckOnFailureAction(String healthcheckOnFailureAction)

    • getHealthcheckOnFailureAction

      @Nullable public String getHealthcheckOnFailureAction()
      HealthcheckOnFailureAction defines an action to take once the container turns unhealthy.
      Returns:
      healthcheckOnFailureAction

    • setHealthcheckOnFailureAction

      public void setHealthcheckOnFailureAction(String healthcheckOnFailureAction)

    • hostname

      public InspectContainerConfig hostname(String hostname)

    • getHostname

      @Nullable public String getHostname()
      Container hostname
      Returns:
      hostname

    • setHostname

      public void setHostname(String hostname)

    • image

      public InspectContainerConfig image(String image)

    • getImage

      @Nullable public String getImage()
      Container image
      Returns:
      image

    • setImage

      public void setImage(String image)

    • labels

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

    • putLabelsItem

      public InspectContainerConfig putLabelsItem(String key, String labelsItem)

    • getLabels

      @Nullable public Map<String,String> getLabels()
      Container labels
      Returns:
      labels

    • setLabels

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

    • onBuild

      public InspectContainerConfig onBuild(String onBuild)

    • getOnBuild

      @Nullable public String getOnBuild()
      On-build arguments - presently unused. More of Buildah's domain.
      Returns:
      onBuild

    • setOnBuild

      public void setOnBuild(String onBuild)

    • openStdin

      public InspectContainerConfig openStdin(Boolean openStdin)

    • getOpenStdin

      @Nullable public Boolean getOpenStdin()
      Whether the container leaves STDIN open
      Returns:
      openStdin

    • setOpenStdin

      public void setOpenStdin(Boolean openStdin)

    • passwd

      public InspectContainerConfig passwd(Boolean passwd)

    • getPasswd

      @Nullable public Boolean getPasswd()
      Passwd determines whether or not podman can add entries to /etc/passwd and /etc/group
      Returns:
      passwd

    • setPasswd

      public void setPasswd(Boolean passwd)

    • secrets

      public InspectContainerConfig secrets(List<InspectSecret> secrets)

    • addSecretsItem

      public InspectContainerConfig addSecretsItem(InspectSecret secretsItem)

    • getSecrets

      @Nullable @Valid public @Valid List<InspectSecret> getSecrets()
      Secrets are the secrets mounted in the container
      Returns:
      secrets

    • setSecrets

      public void setSecrets(List<InspectSecret> secrets)

    • startupHealthCheck

      public InspectContainerConfig startupHealthCheck(StartupHealthCheck startupHealthCheck)

    • getStartupHealthCheck

      @Nullable @Valid public @Valid StartupHealthCheck getStartupHealthCheck()
      Get startupHealthCheck
      Returns:
      startupHealthCheck

    • setStartupHealthCheck

      public void setStartupHealthCheck(StartupHealthCheck startupHealthCheck)

    • stdinOnce

      public InspectContainerConfig stdinOnce(Boolean stdinOnce)

    • getStdinOnce

      @Nullable public Boolean getStdinOnce()
      Whether STDIN is only left open once. Presently not supported by Podman, unused.
      Returns:
      stdinOnce

    • setStdinOnce

      public void setStdinOnce(Boolean stdinOnce)

    • stopSignal

      public InspectContainerConfig stopSignal(String stopSignal)

    • getStopSignal

      @Nullable public String getStopSignal()
      Container stop signal
      Returns:
      stopSignal

    • setStopSignal

      public void setStopSignal(String stopSignal)

    • stopTimeout

      public InspectContainerConfig stopTimeout(Integer stopTimeout)

    • getStopTimeout

      @Nullable public Integer getStopTimeout()
      StopTimeout is time before container is stopped when calling stop
      Returns:
      stopTimeout

    • setStopTimeout

      public void setStopTimeout(Integer stopTimeout)

    • systemdMode

      public InspectContainerConfig systemdMode(Boolean systemdMode)

    • getSystemdMode

      @Nullable public Boolean getSystemdMode()
      SystemdMode is whether the container is running in systemd mode. In systemd mode, the container configuration is customized to optimize running systemd in the container.
      Returns:
      systemdMode

    • setSystemdMode

      public void setSystemdMode(Boolean systemdMode)

    • timeout

      public InspectContainerConfig timeout(Integer timeout)

    • getTimeout

      @Nullable public Integer getTimeout()
      Timeout is time before container is killed by conmon
      Returns:
      timeout

    • setTimeout

      public void setTimeout(Integer timeout)

    • timezone

      public InspectContainerConfig timezone(String timezone)

    • getTimezone

      @Nullable public String getTimezone()
      Timezone is the timezone inside the container. Local means it has the same timezone as the host machine
      Returns:
      timezone

    • setTimezone

      public void setTimezone(String timezone)

    • tty

      public InspectContainerConfig tty(Boolean tty)

    • getTty

      @Nullable public Boolean getTty()
      Whether the container creates a TTY
      Returns:
      tty

    • setTty

      public void setTty(Boolean tty)

    • umask

      public InspectContainerConfig umask(String umask)

    • getUmask

      @Nullable public String getUmask()
      Umask is the umask inside the container.
      Returns:
      umask

    • setUmask

      public void setUmask(String umask)

    • user

      public InspectContainerConfig user(String user)

    • getUser

      @Nullable public String getUser()
      User the container was launched with
      Returns:
      user

    • setUser

      public void setUser(String user)

    • volumes

      public InspectContainerConfig volumes(Map<String,Object> volumes)

    • putVolumesItem

      public InspectContainerConfig putVolumesItem(String key, Object volumesItem)

    • getVolumes

      @Nullable public Map<String,Object> getVolumes()
      Unused, at present. I've never seen this field populated.
      Returns:
      volumes

    • setVolumes

      public void setVolumes(Map<String,Object> volumes)

    • workingDir

      public InspectContainerConfig workingDir(String workingDir)

    • getWorkingDir

      @Nullable public String getWorkingDir()
      Container working directory
      Returns:
      workingDir

    • setWorkingDir

      public void setWorkingDir(String workingDir)

    • sdNotifyMode

      public InspectContainerConfig sdNotifyMode(String sdNotifyMode)

    • getSdNotifyMode

      @Nullable public String getSdNotifyMode()
      SdNotifyMode is the sd-notify mode of the container.
      Returns:
      sdNotifyMode

    • setSdNotifyMode

      public void setSdNotifyMode(String sdNotifyMode)

    • sdNotifySocket

      public InspectContainerConfig sdNotifySocket(String sdNotifySocket)

    • getSdNotifySocket

      @Nullable public String getSdNotifySocket()
      SdNotifySocket is the NOTIFY_SOCKET in use by/configured for the container.
      Returns:
      sdNotifySocket

    • setSdNotifySocket

      public void setSdNotifySocket(String sdNotifySocket)

    • 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

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to InspectContainerConfig

    • fromJson

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

    • toJson

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