Package io.micronaut.kubernetes.client.openapi.model

Class V1EphemeralContainer

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1EphemeralContainer
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") 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(String name)

  • Method Details

    • getName

      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:
      the name property value

    • setName

      public void setName(String name)
      Set the name property value
      Parameters:
      name - property value to set

    • name

      public V1EphemeralContainer name(String name)
      Set name in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getArgs

      public List<@NotNull 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:
      the args property value

    • setArgs

      public void setArgs(List<@NotNull String> args)
      Set the args property value
      Parameters:
      args - property value to set

    • args

      public V1EphemeralContainer args(List<@NotNull String> args)
      Set args in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addargsItem

      public V1EphemeralContainer addargsItem(String argsItem)
      Add an item to the args property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getCommand

      public List<@NotNull 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:
      the command property value

    • setCommand

      public void setCommand(List<@NotNull String> command)
      Set the command property value
      Parameters:
      command - property value to set

    • command

      public V1EphemeralContainer command(List<@NotNull String> command)
      Set command in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addcommandItem

      public V1EphemeralContainer addcommandItem(String commandItem)
      Add an item to the command property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getEnv

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

    • setEnv

      public void setEnv(List<@Valid V1EnvVar> env)
      Set the env property value
      Parameters:
      env - property value to set

    • env

      public V1EphemeralContainer env(List<@Valid V1EnvVar> env)
      Set env in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addenvItem

      public V1EphemeralContainer addenvItem(V1EnvVar envItem)
      Add an item to the env property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getEnvFrom

      public List<@Valid 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:
      the envFrom property value

    • setEnvFrom

      public void setEnvFrom(List<@Valid V1EnvFromSource> envFrom)
      Set the envFrom property value
      Parameters:
      envFrom - property value to set

    • envFrom

      public V1EphemeralContainer envFrom(List<@Valid V1EnvFromSource> envFrom)
      Set envFrom in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addenvFromItem

      public V1EphemeralContainer addenvFromItem(V1EnvFromSource envFromItem)
      Add an item to the envFrom property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getImage

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

    • setImage

      public void setImage(String image)
      Set the image property value
      Parameters:
      image - property value to set

    • image

      public V1EphemeralContainer image(String image)
      Set image in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getImagePullPolicy

      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:
      the imagePullPolicy property value

    • setImagePullPolicy

      public void setImagePullPolicy(String imagePullPolicy)
      Set the imagePullPolicy property value
      Parameters:
      imagePullPolicy - property value to set

    • imagePullPolicy

      public V1EphemeralContainer imagePullPolicy(String imagePullPolicy)
      Set imagePullPolicy in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getLifecycle

      public V1Lifecycle getLifecycle()
      Returns:
      the lifecycle property value

    • setLifecycle

      public void setLifecycle(V1Lifecycle lifecycle)
      Set the lifecycle property value
      Parameters:
      lifecycle - property value to set

    • lifecycle

      public V1EphemeralContainer lifecycle(V1Lifecycle lifecycle)
      Set lifecycle in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getLivenessProbe

      public V1Probe getLivenessProbe()
      Returns:
      the livenessProbe property value

    • setLivenessProbe

      public void setLivenessProbe(V1Probe livenessProbe)
      Set the livenessProbe property value
      Parameters:
      livenessProbe - property value to set

    • livenessProbe

      public V1EphemeralContainer livenessProbe(V1Probe livenessProbe)
      Set livenessProbe in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getPorts

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

    • setPorts

      public void setPorts(List<@Valid V1ContainerPort> ports)
      Set the ports property value
      Parameters:
      ports - property value to set

    • ports

      public V1EphemeralContainer ports(List<@Valid V1ContainerPort> ports)
      Set ports in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addportsItem

      public V1EphemeralContainer addportsItem(V1ContainerPort portsItem)
      Add an item to the ports property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getReadinessProbe

      public V1Probe getReadinessProbe()
      Returns:
      the readinessProbe property value

    • setReadinessProbe

      public void setReadinessProbe(V1Probe readinessProbe)
      Set the readinessProbe property value
      Parameters:
      readinessProbe - property value to set

    • readinessProbe

      public V1EphemeralContainer readinessProbe(V1Probe readinessProbe)
      Set readinessProbe in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getResizePolicy

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

    • setResizePolicy

      public void setResizePolicy(List<@Valid V1ContainerResizePolicy> resizePolicy)
      Set the resizePolicy property value
      Parameters:
      resizePolicy - property value to set

    • resizePolicy

      public V1EphemeralContainer resizePolicy(List<@Valid V1ContainerResizePolicy> resizePolicy)
      Set resizePolicy in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addresizePolicyItem

      public V1EphemeralContainer addresizePolicyItem(V1ContainerResizePolicy resizePolicyItem)
      Add an item to the resizePolicy property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getResources

      public V1ResourceRequirements getResources()
      Returns:
      the resources property value

    • setResources

      public void setResources(V1ResourceRequirements resources)
      Set the resources property value
      Parameters:
      resources - property value to set

    • resources

      public V1EphemeralContainer resources(V1ResourceRequirements resources)
      Set resources in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getSecurityContext

      public V1SecurityContext getSecurityContext()
      Returns:
      the securityContext property value

    • setSecurityContext

      public void setSecurityContext(V1SecurityContext securityContext)
      Set the securityContext property value
      Parameters:
      securityContext - property value to set

    • securityContext

      public V1EphemeralContainer securityContext(V1SecurityContext securityContext)
      Set securityContext in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getStartupProbe

      public V1Probe getStartupProbe()
      Returns:
      the startupProbe property value

    • setStartupProbe

      public void setStartupProbe(V1Probe startupProbe)
      Set the startupProbe property value
      Parameters:
      startupProbe - property value to set

    • startupProbe

      public V1EphemeralContainer startupProbe(V1Probe startupProbe)
      Set startupProbe in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getStdin

      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:
      the stdin property value

    • setStdin

      public void setStdin(Boolean stdin)
      Set the stdin property value
      Parameters:
      stdin - property value to set

    • stdin

      public V1EphemeralContainer stdin(Boolean stdin)
      Set stdin in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getStdinOnce

      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:
      the stdinOnce property value

    • setStdinOnce

      public void setStdinOnce(Boolean stdinOnce)
      Set the stdinOnce property value
      Parameters:
      stdinOnce - property value to set

    • stdinOnce

      public V1EphemeralContainer stdinOnce(Boolean stdinOnce)
      Set stdinOnce in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getTargetContainerName

      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:
      the targetContainerName property value

    • setTargetContainerName

      public void setTargetContainerName(String targetContainerName)
      Set the targetContainerName property value
      Parameters:
      targetContainerName - property value to set

    • targetContainerName

      public V1EphemeralContainer targetContainerName(String targetContainerName)
      Set targetContainerName in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getTerminationMessagePath

      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:
      the terminationMessagePath property value

    • setTerminationMessagePath

      public void setTerminationMessagePath(String terminationMessagePath)
      Set the terminationMessagePath property value
      Parameters:
      terminationMessagePath - property value to set

    • terminationMessagePath

      public V1EphemeralContainer terminationMessagePath(String terminationMessagePath)
      Set terminationMessagePath in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getTerminationMessagePolicy

      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:
      the terminationMessagePolicy property value

    • setTerminationMessagePolicy

      public void setTerminationMessagePolicy(String terminationMessagePolicy)
      Set the terminationMessagePolicy property value
      Parameters:
      terminationMessagePolicy - property value to set

    • terminationMessagePolicy

      public V1EphemeralContainer terminationMessagePolicy(String terminationMessagePolicy)
      Set terminationMessagePolicy in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getTty

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

    • setTty

      public void setTty(Boolean tty)
      Set the tty property value
      Parameters:
      tty - property value to set

    • tty

      public V1EphemeralContainer tty(Boolean tty)
      Set tty in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getVolumeDevices

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

    • setVolumeDevices

      public void setVolumeDevices(List<@Valid V1VolumeDevice> volumeDevices)
      Set the volumeDevices property value
      Parameters:
      volumeDevices - property value to set

    • volumeDevices

      public V1EphemeralContainer volumeDevices(List<@Valid V1VolumeDevice> volumeDevices)
      Set volumeDevices in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addvolumeDevicesItem

      public V1EphemeralContainer addvolumeDevicesItem(V1VolumeDevice volumeDevicesItem)
      Add an item to the volumeDevices property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getVolumeMounts

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

    • setVolumeMounts

      public void setVolumeMounts(List<@Valid V1VolumeMount> volumeMounts)
      Set the volumeMounts property value
      Parameters:
      volumeMounts - property value to set

    • volumeMounts

      public V1EphemeralContainer volumeMounts(List<@Valid V1VolumeMount> volumeMounts)
      Set volumeMounts in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • addvolumeMountsItem

      public V1EphemeralContainer addvolumeMountsItem(V1VolumeMount volumeMountsItem)
      Add an item to the volumeMounts property in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • getWorkingDir

      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:
      the workingDir property value

    • setWorkingDir

      public void setWorkingDir(String workingDir)
      Set the workingDir property value
      Parameters:
      workingDir - property value to set

    • workingDir

      public V1EphemeralContainer workingDir(String workingDir)
      Set workingDir in a chainable fashion.
      Returns:
      The same instance of V1EphemeralContainer for chaining.

    • 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