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

Class ImageConfig

java.lang.Object
io.github.alersrt.pod4j.openapi.model.ImageConfig
All Implemented Interfaces:
Serializable
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class ImageConfig extends Object implements Serializable
ImageConfig
See Also:

  • Field Details

  • Constructor Details

    • ImageConfig

      public ImageConfig()

  • Method Details

    • argsEscaped

      public ImageConfig argsEscaped(Boolean argsEscaped)

    • getArgsEscaped

      @Nullable public Boolean getArgsEscaped()
      ArgsEscaped Deprecated: This field is present only for legacy compatibility with Docker and should not be used by new image builders. It is used by Docker for Windows images to indicate that the `Entrypoint` or `Cmd` or both, contains only a single element array, that is a pre-escaped, and combined into a single string `CommandLine`. If `true` the value in `Entrypoint` or `Cmd` should be used as-is to avoid double escaping. https://github.com/opencontainers/image-spec/pull/892
      Returns:
      argsEscaped

    • setArgsEscaped

      public void setArgsEscaped(Boolean argsEscaped)

    • cmd

      public ImageConfig cmd(List<String> cmd)

    • addCmdItem

      public ImageConfig addCmdItem(String cmdItem)

    • getCmd

      @Nullable public List<String> getCmd()
      Cmd defines the default arguments to the entrypoint of the container.
      Returns:
      cmd

    • setCmd

      public void setCmd(List<String> cmd)

    • entrypoint

      public ImageConfig entrypoint(List<String> entrypoint)

    • addEntrypointItem

      public ImageConfig addEntrypointItem(String entrypointItem)

    • getEntrypoint

      @Nullable public List<String> getEntrypoint()
      Entrypoint defines a list of arguments to use as the command to execute when the container starts.
      Returns:
      entrypoint

    • setEntrypoint

      public void setEntrypoint(List<String> entrypoint)

    • env

      public ImageConfig env(List<String> env)

    • addEnvItem

      public ImageConfig addEnvItem(String envItem)

    • getEnv

      @Nullable public List<String> getEnv()
      Env is a list of environment variables to be used in a container.
      Returns:
      env

    • setEnv

      public void setEnv(List<String> env)

    • exposedPorts

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

    • putExposedPortsItem

      public ImageConfig putExposedPortsItem(String key, Object exposedPortsItem)

    • getExposedPorts

      @Nullable public Map<String,Object> getExposedPorts()
      ExposedPorts a set of ports to expose from a container running this image.
      Returns:
      exposedPorts

    • setExposedPorts

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

    • labels

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

    • putLabelsItem

      public ImageConfig putLabelsItem(String key, String labelsItem)

    • getLabels

      @Nullable public Map<String,String> getLabels()
      Labels contains arbitrary metadata for the container.
      Returns:
      labels

    • setLabels

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

    • stopSignal

      public ImageConfig stopSignal(String stopSignal)

    • getStopSignal

      @Nullable public String getStopSignal()
      StopSignal contains the system call signal that will be sent to the container to exit.
      Returns:
      stopSignal

    • setStopSignal

      public void setStopSignal(String stopSignal)

    • user

      public ImageConfig user(String user)

    • getUser

      @Nullable public String getUser()
      User defines the username or UID which the process in the container should run as.
      Returns:
      user

    • setUser

      public void setUser(String user)

    • volumes

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

    • putVolumesItem

      public ImageConfig putVolumesItem(String key, Object volumesItem)

    • getVolumes

      @Nullable public Map<String,Object> getVolumes()
      Volumes is a set of directories describing where the process is likely write data specific to a container instance.
      Returns:
      volumes

    • setVolumes

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

    • workingDir

      public ImageConfig workingDir(String workingDir)

    • getWorkingDir

      @Nullable public String getWorkingDir()
      WorkingDir sets the current working directory of the entrypoint process in the container.
      Returns:
      workingDir

    • setWorkingDir

      public void setWorkingDir(String workingDir)

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

    • fromJson

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

    • toJson

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