Package io.kubernetes.client.openapi.models

Class V1EphemeralContainer

java.lang.Object
io.kubernetes.client.openapi.models.V1EphemeralContainer
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-05-20T20:47:13.890592Z[Etc/UTC]", comments="Generator version: 7.13.0") public class V1EphemeralContainer extends Object
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

  • Field Details

  • Constructor Details

    • V1EphemeralContainer

      public V1EphemeralContainer()

  • Method Details

    • args

      public V1EphemeralContainer args(@Nullable List<String> args)

    • addArgsItem

      public V1EphemeralContainer addArgsItem(String argsItem)

    • getArgs

      @Nullable public List<String> getArgs()
      Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
      Returns:
      args

    • setArgs

      public void setArgs(@Nullable List<String> args)

    • command

      public V1EphemeralContainer command(@Nullable List<String> command)

    • addCommandItem

      public V1EphemeralContainer addCommandItem(String commandItem)

    • getCommand

      @Nullable public List<String> getCommand()
      Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
      Returns:
      command

    • setCommand

      public void setCommand(@Nullable List<String> command)

    • env

      public V1EphemeralContainer env(@Nullable List<V1EnvVar> env)

    • addEnvItem

      public V1EphemeralContainer addEnvItem(V1EnvVar envItem)

    • getEnv

      @Nullable public List<V1EnvVar> getEnv()
      List of environment variables to set in the container. Cannot be updated.
      Returns:
      env

    • setEnv

      public void setEnv(@Nullable List<V1EnvVar> env)

    • envFrom

      public V1EphemeralContainer envFrom(@Nullable List<V1EnvFromSource> envFrom)

    • addEnvFromItem

      public V1EphemeralContainer addEnvFromItem(V1EnvFromSource envFromItem)

    • getEnvFrom

      @Nullable public List<V1EnvFromSource> getEnvFrom()
      List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
      Returns:
      envFrom

    • setEnvFrom

      public void setEnvFrom(@Nullable List<V1EnvFromSource> envFrom)

    • image

      public V1EphemeralContainer image(@Nullable String image)

    • getImage

      @Nullable public String getImage()
      Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
      Returns:
      image

    • setImage

      public void setImage(@Nullable String image)

    • imagePullPolicy

      public V1EphemeralContainer imagePullPolicy(@Nullable String imagePullPolicy)

    • getImagePullPolicy

      @Nullable public String getImagePullPolicy()
      Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
      Returns:
      imagePullPolicy

    • setImagePullPolicy

      public void setImagePullPolicy(@Nullable String imagePullPolicy)

    • lifecycle

      public V1EphemeralContainer lifecycle(@Nullable V1Lifecycle lifecycle)

    • getLifecycle

      @Nullable public V1Lifecycle getLifecycle()
      Get lifecycle
      Returns:
      lifecycle

    • setLifecycle

      public void setLifecycle(@Nullable V1Lifecycle lifecycle)

    • livenessProbe

      public V1EphemeralContainer livenessProbe(@Nullable V1Probe livenessProbe)

    • getLivenessProbe

      @Nullable public V1Probe getLivenessProbe()
      Get livenessProbe
      Returns:
      livenessProbe

    • setLivenessProbe

      public void setLivenessProbe(@Nullable V1Probe livenessProbe)

    • name

      public V1EphemeralContainer name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • ports

      public V1EphemeralContainer ports(@Nullable List<V1ContainerPort> ports)

    • addPortsItem

      public V1EphemeralContainer addPortsItem(V1ContainerPort portsItem)

    • getPorts

      @Nullable public List<V1ContainerPort> getPorts()
      Ports are not allowed for ephemeral containers.
      Returns:
      ports

    • setPorts

      public void setPorts(@Nullable List<V1ContainerPort> ports)

    • readinessProbe

      public V1EphemeralContainer readinessProbe(@Nullable V1Probe readinessProbe)

    • getReadinessProbe

      @Nullable public V1Probe getReadinessProbe()
      Get readinessProbe
      Returns:
      readinessProbe

    • setReadinessProbe

      public void setReadinessProbe(@Nullable V1Probe readinessProbe)

    • resizePolicy

      public V1EphemeralContainer resizePolicy(@Nullable List<V1ContainerResizePolicy> resizePolicy)

    • addResizePolicyItem

      public V1EphemeralContainer addResizePolicyItem(V1ContainerResizePolicy resizePolicyItem)

    • getResizePolicy

      @Nullable public List<V1ContainerResizePolicy> getResizePolicy()
      Resources resize policy for the container.
      Returns:
      resizePolicy

    • setResizePolicy

      public void setResizePolicy(@Nullable List<V1ContainerResizePolicy> resizePolicy)

    • resources

      public V1EphemeralContainer resources(@Nullable V1ResourceRequirements resources)

    • getResources

      @Nullable public V1ResourceRequirements getResources()
      Get resources
      Returns:
      resources

    • setResources

      public void setResources(@Nullable V1ResourceRequirements resources)

    • restartPolicy

      public V1EphemeralContainer restartPolicy(@Nullable String restartPolicy)

    • getRestartPolicy

      @Nullable public String getRestartPolicy()
      Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers.
      Returns:
      restartPolicy

    • setRestartPolicy

      public void setRestartPolicy(@Nullable String restartPolicy)

    • securityContext

      public V1EphemeralContainer securityContext(@Nullable V1SecurityContext securityContext)

    • getSecurityContext

      @Nullable public V1SecurityContext getSecurityContext()
      Get securityContext
      Returns:
      securityContext

    • setSecurityContext

      public void setSecurityContext(@Nullable V1SecurityContext securityContext)

    • startupProbe

      public V1EphemeralContainer startupProbe(@Nullable V1Probe startupProbe)

    • getStartupProbe

      @Nullable public V1Probe getStartupProbe()
      Get startupProbe
      Returns:
      startupProbe

    • setStartupProbe

      public void setStartupProbe(@Nullable V1Probe startupProbe)

    • stdin

      public V1EphemeralContainer stdin(@Nullable Boolean stdin)

    • getStdin

      @Nullable public Boolean getStdin()
      Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
      Returns:
      stdin

    • setStdin

      public void setStdin(@Nullable Boolean stdin)

    • stdinOnce

      public V1EphemeralContainer stdinOnce(@Nullable Boolean stdinOnce)

    • getStdinOnce

      @Nullable public Boolean getStdinOnce()
      Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
      Returns:
      stdinOnce

    • setStdinOnce

      public void setStdinOnce(@Nullable Boolean stdinOnce)

    • targetContainerName

      public V1EphemeralContainer targetContainerName(@Nullable String targetContainerName)

    • getTargetContainerName

      @Nullable public String getTargetContainerName()
      If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
      Returns:
      targetContainerName

    • setTargetContainerName

      public void setTargetContainerName(@Nullable String targetContainerName)

    • terminationMessagePath

      public V1EphemeralContainer terminationMessagePath(@Nullable String terminationMessagePath)

    • getTerminationMessagePath

      @Nullable public String getTerminationMessagePath()
      Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
      Returns:
      terminationMessagePath

    • setTerminationMessagePath

      public void setTerminationMessagePath(@Nullable String terminationMessagePath)

    • terminationMessagePolicy

      public V1EphemeralContainer terminationMessagePolicy(@Nullable String terminationMessagePolicy)

    • getTerminationMessagePolicy

      @Nullable public String getTerminationMessagePolicy()
      Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
      Returns:
      terminationMessagePolicy

    • setTerminationMessagePolicy

      public void setTerminationMessagePolicy(@Nullable String terminationMessagePolicy)

    • tty

      public V1EphemeralContainer tty(@Nullable Boolean tty)

    • getTty

      @Nullable public Boolean getTty()
      Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
      Returns:
      tty

    • setTty

      public void setTty(@Nullable Boolean tty)

    • volumeDevices

      public V1EphemeralContainer volumeDevices(@Nullable List<V1VolumeDevice> volumeDevices)

    • addVolumeDevicesItem

      public V1EphemeralContainer addVolumeDevicesItem(V1VolumeDevice volumeDevicesItem)

    • getVolumeDevices

      @Nullable public List<V1VolumeDevice> getVolumeDevices()
      volumeDevices is the list of block devices to be used by the container.
      Returns:
      volumeDevices

    • setVolumeDevices

      public void setVolumeDevices(@Nullable List<V1VolumeDevice> volumeDevices)

    • volumeMounts

      public V1EphemeralContainer volumeMounts(@Nullable List<V1VolumeMount> volumeMounts)

    • addVolumeMountsItem

      public V1EphemeralContainer addVolumeMountsItem(V1VolumeMount volumeMountsItem)

    • getVolumeMounts

      @Nullable public List<V1VolumeMount> getVolumeMounts()
      Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
      Returns:
      volumeMounts

    • setVolumeMounts

      public void setVolumeMounts(@Nullable List<V1VolumeMount> volumeMounts)

    • workingDir

      public V1EphemeralContainer workingDir(@Nullable String workingDir)

    • getWorkingDir

      @Nullable public String getWorkingDir()
      Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
      Returns:
      workingDir

    • setWorkingDir

      public void setWorkingDir(@Nullable 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

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

    • fromJson

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

    • toJson

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