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 Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddargsItem
(String argsItem) Add an item to the args property in a chainable fashion.addcommandItem
(String commandItem) Add an item to the command property in a chainable fashion.addenvFromItem
(V1EnvFromSource envFromItem) Add an item to the envFrom property in a chainable fashion.addenvItem
(V1EnvVar envItem) Add an item to the env property in a chainable fashion.addportsItem
(V1ContainerPort portsItem) Add an item to the ports property in a chainable fashion.addresizePolicyItem
(V1ContainerResizePolicy resizePolicyItem) Add an item to the resizePolicy property in a chainable fashion.addvolumeDevicesItem
(V1VolumeDevice volumeDevicesItem) Add an item to the volumeDevices property in a chainable fashion.addvolumeMountsItem
(V1VolumeMount volumeMountsItem) Add an item to the volumeMounts property in a chainable fashion.Set args in a chainable fashion.Set command in a chainable fashion.Set env in a chainable fashion.envFrom
(List<@Valid V1EnvFromSource> envFrom) Set envFrom in a chainable fashion.boolean
getArgs()
Arguments to the entrypoint.Entrypoint array.getEnv()
List of environment variables to set in the container.List<@Valid V1EnvFromSource>
List of sources to populate environment variables in the container.getImage()
Container image name.Image pull policy.getName()
Name of the ephemeral container specified as a DNS_LABEL.List<@Valid V1ContainerPort>
getPorts()
Ports are not allowed for ephemeral containers.List<@Valid V1ContainerResizePolicy>
Resources resize policy for the container.getStdin()
Whether this container should allocate a buffer for stdin in the container runtime.Whether the container runtime should close the stdin channel after it has been opened by a single attach.If set, the name of the container from PodSpec that this ephemeral container targets.Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem.Indicate how the termination message should be populated.getTty()
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.List<@Valid V1VolumeDevice>
volumeDevices is the list of block devices to be used by the container.List<@Valid V1VolumeMount>
Pod volumes to mount into the container's filesystem.Container's working directory.int
hashCode()
Set image in a chainable fashion.imagePullPolicy
(String imagePullPolicy) Set imagePullPolicy in a chainable fashion.lifecycle
(V1Lifecycle lifecycle) Set lifecycle in a chainable fashion.livenessProbe
(V1Probe livenessProbe) Set livenessProbe in a chainable fashion.Set name in a chainable fashion.ports
(List<@Valid V1ContainerPort> ports) Set ports in a chainable fashion.readinessProbe
(V1Probe readinessProbe) Set readinessProbe in a chainable fashion.resizePolicy
(List<@Valid V1ContainerResizePolicy> resizePolicy) Set resizePolicy in a chainable fashion.resources
(V1ResourceRequirements resources) Set resources in a chainable fashion.securityContext
(V1SecurityContext securityContext) Set securityContext in a chainable fashion.void
Set the args property valuevoid
setCommand
(List<String> command) Set the command property valuevoid
Set the env property valuevoid
setEnvFrom
(List<@Valid V1EnvFromSource> envFrom) Set the envFrom property valuevoid
Set the image property valuevoid
setImagePullPolicy
(String imagePullPolicy) Set the imagePullPolicy property valuevoid
setLifecycle
(V1Lifecycle lifecycle) Set the lifecycle property valuevoid
setLivenessProbe
(V1Probe livenessProbe) Set the livenessProbe property valuevoid
Set the name property valuevoid
setPorts
(List<@Valid V1ContainerPort> ports) Set the ports property valuevoid
setReadinessProbe
(V1Probe readinessProbe) Set the readinessProbe property valuevoid
setResizePolicy
(List<@Valid V1ContainerResizePolicy> resizePolicy) Set the resizePolicy property valuevoid
setResources
(V1ResourceRequirements resources) Set the resources property valuevoid
setSecurityContext
(V1SecurityContext securityContext) Set the securityContext property valuevoid
setStartupProbe
(V1Probe startupProbe) Set the startupProbe property valuevoid
Set the stdin property valuevoid
setStdinOnce
(Boolean stdinOnce) Set the stdinOnce property valuevoid
setTargetContainerName
(String targetContainerName) Set the targetContainerName property valuevoid
setTerminationMessagePath
(String terminationMessagePath) Set the terminationMessagePath property valuevoid
setTerminationMessagePolicy
(String terminationMessagePolicy) Set the terminationMessagePolicy property valuevoid
Set the tty property valuevoid
setVolumeDevices
(List<@Valid V1VolumeDevice> volumeDevices) Set the volumeDevices property valuevoid
setVolumeMounts
(List<@Valid V1VolumeMount> volumeMounts) Set the volumeMounts property valuevoid
setWorkingDir
(String workingDir) Set the workingDir property valuestartupProbe
(V1Probe startupProbe) Set startupProbe in a chainable fashion.Set stdin in a chainable fashion.Set stdinOnce in a chainable fashion.targetContainerName
(String targetContainerName) Set targetContainerName in a chainable fashion.terminationMessagePath
(String terminationMessagePath) Set terminationMessagePath in a chainable fashion.terminationMessagePolicy
(String terminationMessagePolicy) Set terminationMessagePolicy in a chainable fashion.toString()
Set tty in a chainable fashion.volumeDevices
(List<@Valid V1VolumeDevice> volumeDevices) Set volumeDevices in a chainable fashion.volumeMounts
(List<@Valid V1VolumeMount> volumeMounts) Set volumeMounts in a chainable fashion.workingDir
(String workingDir) Set workingDir in a chainable fashion.
-
Field Details
-
JSON_PROPERTY_ARGS
- See Also:
-
JSON_PROPERTY_COMMAND
- See Also:
-
JSON_PROPERTY_ENV
- See Also:
-
JSON_PROPERTY_ENV_FROM
- See Also:
-
JSON_PROPERTY_IMAGE
- See Also:
-
JSON_PROPERTY_IMAGE_PULL_POLICY
- See Also:
-
JSON_PROPERTY_LIFECYCLE
- See Also:
-
JSON_PROPERTY_LIVENESS_PROBE
- See Also:
-
JSON_PROPERTY_NAME
- See Also:
-
JSON_PROPERTY_PORTS
- See Also:
-
JSON_PROPERTY_READINESS_PROBE
- See Also:
-
JSON_PROPERTY_RESIZE_POLICY
- See Also:
-
JSON_PROPERTY_RESOURCES
- See Also:
-
JSON_PROPERTY_SECURITY_CONTEXT
- See Also:
-
JSON_PROPERTY_STARTUP_PROBE
- See Also:
-
JSON_PROPERTY_STDIN
- See Also:
-
JSON_PROPERTY_STDIN_ONCE
- See Also:
-
JSON_PROPERTY_TARGET_CONTAINER_NAME
- See Also:
-
JSON_PROPERTY_TERMINATION_MESSAGE_PATH
- See Also:
-
JSON_PROPERTY_TERMINATION_MESSAGE_POLICY
- See Also:
-
JSON_PROPERTY_TTY
- See Also:
-
JSON_PROPERTY_VOLUME_DEVICES
- See Also:
-
JSON_PROPERTY_VOLUME_MOUNTS
- See Also:
-
JSON_PROPERTY_WORKING_DIR
- See Also:
-
-
Constructor Details
-
V1EphemeralContainer
-
-
Method Details
-
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
Set the args property value -
args
Set args in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addargsItem
Add an item to the args property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the command property value -
command
Set command in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addcommandItem
Add an item to the command property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getEnv
List of environment variables to set in the container. Cannot be updated.- Returns:
- the env property value
-
setEnv
Set the env property value -
env
Set env in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addenvItem
Add an item to the env property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the envFrom property value -
envFrom
Set envFrom in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addenvFromItem
Add an item to the envFrom property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getImage
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images- Returns:
- the image property value
-
setImage
Set the image property value -
image
Set image in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the imagePullPolicy property value -
imagePullPolicy
Set imagePullPolicy in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getLifecycle
- Returns:
- the lifecycle property value
-
setLifecycle
Set the lifecycle property value -
lifecycle
Set lifecycle in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getLivenessProbe
- Returns:
- the livenessProbe property value
-
setLivenessProbe
Set the livenessProbe property value -
livenessProbe
Set livenessProbe in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the name property value -
name
Set name in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getPorts
Ports are not allowed for ephemeral containers.- Returns:
- the ports property value
-
setPorts
Set the ports property value -
ports
Set ports in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addportsItem
Add an item to the ports property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getReadinessProbe
- Returns:
- the readinessProbe property value
-
setReadinessProbe
Set the readinessProbe property value -
readinessProbe
Set readinessProbe in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getResizePolicy
Resources resize policy for the container.- Returns:
- the resizePolicy property value
-
setResizePolicy
Set the resizePolicy property value -
resizePolicy
Set resizePolicy in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addresizePolicyItem
Add an item to the resizePolicy property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getResources
- Returns:
- the resources property value
-
setResources
Set the resources property value -
resources
Set resources in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getSecurityContext
- Returns:
- the securityContext property value
-
setSecurityContext
Set the securityContext property value -
securityContext
Set securityContext in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getStartupProbe
- Returns:
- the startupProbe property value
-
setStartupProbe
Set the startupProbe property value -
startupProbe
Set startupProbe in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the stdin property value -
stdin
Set stdin in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the stdinOnce property value -
stdinOnce
Set stdinOnce in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the targetContainerName property value -
targetContainerName
Set targetContainerName in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the terminationMessagePath property value -
terminationMessagePath
Set terminationMessagePath in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the terminationMessagePolicy property value -
terminationMessagePolicy
Set terminationMessagePolicy in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the tty property value -
tty
Set tty in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
getVolumeDevices
volumeDevices is the list of block devices to be used by the container.- Returns:
- the volumeDevices property value
-
setVolumeDevices
Set the volumeDevices property value -
volumeDevices
Set volumeDevices in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addvolumeDevicesItem
Add an item to the volumeDevices property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the volumeMounts property value -
volumeMounts
Set volumeMounts in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
addvolumeMountsItem
Add an item to the volumeMounts property in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
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
Set the workingDir property value -
workingDir
Set workingDir in a chainable fashion.- Returns:
- The same instance of V1EphemeralContainer for chaining.
-
equals
-
hashCode
public int hashCode() -
toString
-