Class V1EphemeralContainer
java.lang.Object
io.kubernetes.client.openapi.models.V1EphemeralContainer
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2022-12-05T08:14:34.919Z[Etc/UTC]")
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddArgsItem
(String argsItem) addCommandItem
(String commandItem) addEnvFromItem
(V1EnvFromSource envFromItem) addEnvItem
(V1EnvVar envItem) addPortsItem
(V1ContainerPort portsItem) addVolumeDevicesItem
(V1VolumeDevice volumeDevicesItem) addVolumeMountsItem
(V1VolumeMount volumeMountsItem) envFrom
(List<V1EnvFromSource> envFrom) boolean
getArgs()
Arguments to the entrypoint.Entrypoint array.getEnv()
List of environment variables to set in the container.List of sources to populate environment variables in the container.getImage()
Container image name.Image pull policy.Get lifecycleGet livenessProbegetName()
Name of the ephemeral container specified as a DNS_LABEL.getPorts()
Ports are not allowed for ephemeral containers.Get readinessProbeGet resourcesGet securityContextGet startupProbegetStdin()
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.volumeDevices is the list of block devices to be used by the container.Pod volumes to mount into the container's filesystem.Container's working directory.int
hashCode()
imagePullPolicy
(String imagePullPolicy) lifecycle
(V1Lifecycle lifecycle) livenessProbe
(V1Probe livenessProbe) ports
(List<V1ContainerPort> ports) readinessProbe
(V1Probe readinessProbe) resources
(V1ResourceRequirements resources) securityContext
(V1SecurityContext securityContext) void
void
setCommand
(List<String> command) void
void
setEnvFrom
(List<V1EnvFromSource> envFrom) void
void
setImagePullPolicy
(String imagePullPolicy) void
setLifecycle
(V1Lifecycle lifecycle) void
setLivenessProbe
(V1Probe livenessProbe) void
void
setPorts
(List<V1ContainerPort> ports) void
setReadinessProbe
(V1Probe readinessProbe) void
setResources
(V1ResourceRequirements resources) void
setSecurityContext
(V1SecurityContext securityContext) void
setStartupProbe
(V1Probe startupProbe) void
void
setStdinOnce
(Boolean stdinOnce) void
setTargetContainerName
(String targetContainerName) void
setTerminationMessagePath
(String terminationMessagePath) void
setTerminationMessagePolicy
(String terminationMessagePolicy) void
void
setVolumeDevices
(List<V1VolumeDevice> volumeDevices) void
setVolumeMounts
(List<V1VolumeMount> volumeMounts) void
setWorkingDir
(String workingDir) startupProbe
(V1Probe startupProbe) targetContainerName
(String targetContainerName) terminationMessagePath
(String terminationMessagePath) terminationMessagePolicy
(String terminationMessagePolicy) toString()
volumeDevices
(List<V1VolumeDevice> volumeDevices) volumeMounts
(List<V1VolumeMount> volumeMounts) workingDir
(String workingDir)
-
Field Details
-
SERIALIZED_NAME_ARGS
- See Also:
-
SERIALIZED_NAME_COMMAND
- See Also:
-
SERIALIZED_NAME_ENV
- See Also:
-
SERIALIZED_NAME_ENV_FROM
- See Also:
-
SERIALIZED_NAME_IMAGE
- See Also:
-
SERIALIZED_NAME_IMAGE_PULL_POLICY
- See Also:
-
SERIALIZED_NAME_LIFECYCLE
- See Also:
-
SERIALIZED_NAME_LIVENESS_PROBE
- See Also:
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_PORTS
- See Also:
-
SERIALIZED_NAME_READINESS_PROBE
- See Also:
-
SERIALIZED_NAME_RESOURCES
- See Also:
-
SERIALIZED_NAME_SECURITY_CONTEXT
- See Also:
-
SERIALIZED_NAME_STARTUP_PROBE
- See Also:
-
SERIALIZED_NAME_STDIN
- See Also:
-
SERIALIZED_NAME_STDIN_ONCE
- See Also:
-
SERIALIZED_NAME_TARGET_CONTAINER_NAME
- See Also:
-
SERIALIZED_NAME_TERMINATION_MESSAGE_PATH
- See Also:
-
SERIALIZED_NAME_TERMINATION_MESSAGE_POLICY
- See Also:
-
SERIALIZED_NAME_TTY
- See Also:
-
SERIALIZED_NAME_VOLUME_DEVICES
- See Also:
-
SERIALIZED_NAME_VOLUME_MOUNTS
- See Also:
-
SERIALIZED_NAME_WORKING_DIR
- See Also:
-
-
Constructor Details
-
V1EphemeralContainer
public V1EphemeralContainer()
-
-
Method Details
-
args
-
addArgsItem
-
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
-
command
-
addCommandItem
-
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
-
env
-
addEnvItem
-
getEnv
List of environment variables to set in the container. Cannot be updated.- Returns:
- env
-
setEnv
-
envFrom
-
addEnvFromItem
-
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
-
image
-
getImage
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images- Returns:
- image
-
setImage
-
imagePullPolicy
-
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
-
lifecycle
-
getLifecycle
Get lifecycle- Returns:
- lifecycle
-
setLifecycle
-
livenessProbe
-
getLivenessProbe
Get livenessProbe- Returns:
- livenessProbe
-
setLivenessProbe
-
name
-
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
-
ports
-
addPortsItem
-
getPorts
Ports are not allowed for ephemeral containers.- Returns:
- ports
-
setPorts
-
readinessProbe
-
getReadinessProbe
Get readinessProbe- Returns:
- readinessProbe
-
setReadinessProbe
-
resources
-
getResources
Get resources- Returns:
- resources
-
setResources
-
securityContext
-
getSecurityContext
Get securityContext- Returns:
- securityContext
-
setSecurityContext
-
startupProbe
-
getStartupProbe
Get startupProbe- Returns:
- startupProbe
-
setStartupProbe
-
stdin
-
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
-
stdinOnce
-
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
-
targetContainerName
-
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
-
terminationMessagePath
-
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
-
terminationMessagePolicy
-
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
-
tty
-
getTty
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.- Returns:
- tty
-
setTty
-
volumeDevices
-
addVolumeDevicesItem
-
getVolumeDevices
volumeDevices is the list of block devices to be used by the container.- Returns:
- volumeDevices
-
setVolumeDevices
-
volumeMounts
-
addVolumeMountsItem
-
getVolumeMounts
Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.- Returns:
- volumeMounts
-
setVolumeMounts
-
workingDir
-
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
-
equals
-
hashCode
public int hashCode() -
toString
-