Package net.stickycode.kuuty.model.v18
Class IoK8sApiCoreV1EphemeralContainer
- java.lang.Object
-
- net.stickycode.kuuty.model.v18.IoK8sApiCoreV1EphemeralContainer
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2020-11-26T11:01:11.402583+13:00[Pacific/Auckland]") public class IoK8sApiCoreV1EphemeralContainer extends Object
An EphemeralContainer is a container that may be added temporarily 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. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ARGSstatic StringJSON_PROPERTY_COMMANDstatic StringJSON_PROPERTY_ENVstatic StringJSON_PROPERTY_ENV_FROMstatic StringJSON_PROPERTY_IMAGEstatic StringJSON_PROPERTY_IMAGE_PULL_POLICYstatic StringJSON_PROPERTY_LIFECYCLEstatic StringJSON_PROPERTY_LIVENESS_PROBEstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_PORTSstatic StringJSON_PROPERTY_READINESS_PROBEstatic StringJSON_PROPERTY_RESOURCESstatic StringJSON_PROPERTY_SECURITY_CONTEXTstatic StringJSON_PROPERTY_STARTUP_PROBEstatic StringJSON_PROPERTY_STDINstatic StringJSON_PROPERTY_STDIN_ONCEstatic StringJSON_PROPERTY_TARGET_CONTAINER_NAMEstatic StringJSON_PROPERTY_TERMINATION_MESSAGE_PATHstatic StringJSON_PROPERTY_TERMINATION_MESSAGE_POLICYstatic StringJSON_PROPERTY_TTYstatic StringJSON_PROPERTY_VOLUME_DEVICESstatic StringJSON_PROPERTY_VOLUME_MOUNTSstatic StringJSON_PROPERTY_WORKING_DIR
-
Constructor Summary
Constructors Constructor Description IoK8sApiCoreV1EphemeralContainer()
-
Method Summary
-
-
-
Field Detail
-
JSON_PROPERTY_ARGS
public static final String JSON_PROPERTY_ARGS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COMMAND
public static final String JSON_PROPERTY_COMMAND
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENV
public static final String JSON_PROPERTY_ENV
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENV_FROM
public static final String JSON_PROPERTY_ENV_FROM
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IMAGE
public static final String JSON_PROPERTY_IMAGE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IMAGE_PULL_POLICY
public static final String JSON_PROPERTY_IMAGE_PULL_POLICY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LIFECYCLE
public static final String JSON_PROPERTY_LIFECYCLE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LIVENESS_PROBE
public static final String JSON_PROPERTY_LIVENESS_PROBE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PORTS
public static final String JSON_PROPERTY_PORTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_READINESS_PROBE
public static final String JSON_PROPERTY_READINESS_PROBE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RESOURCES
public static final String JSON_PROPERTY_RESOURCES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SECURITY_CONTEXT
public static final String JSON_PROPERTY_SECURITY_CONTEXT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STARTUP_PROBE
public static final String JSON_PROPERTY_STARTUP_PROBE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STDIN
public static final String JSON_PROPERTY_STDIN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STDIN_ONCE
public static final String JSON_PROPERTY_STDIN_ONCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TARGET_CONTAINER_NAME
public static final String JSON_PROPERTY_TARGET_CONTAINER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMINATION_MESSAGE_PATH
public static final String JSON_PROPERTY_TERMINATION_MESSAGE_PATH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMINATION_MESSAGE_POLICY
public static final String JSON_PROPERTY_TERMINATION_MESSAGE_POLICY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TTY
public static final String JSON_PROPERTY_TTY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VOLUME_DEVICES
public static final String JSON_PROPERTY_VOLUME_DEVICES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VOLUME_MOUNTS
public static final String JSON_PROPERTY_VOLUME_MOUNTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WORKING_DIR
public static final String JSON_PROPERTY_WORKING_DIR
- See Also:
- Constant Field Values
-
-
Method Detail
-
args
public IoK8sApiCoreV1EphemeralContainer args(List<String> args)
-
addArgsItem
public IoK8sApiCoreV1EphemeralContainer addArgsItem(String argsItem)
-
getArgs
@Nullable public List<String> getArgs()
Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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
-
command
public IoK8sApiCoreV1EphemeralContainer command(List<String> command)
-
addCommandItem
public IoK8sApiCoreV1EphemeralContainer addCommandItem(String commandItem)
-
getCommand
@Nullable public List<String> getCommand()
Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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
-
env
public IoK8sApiCoreV1EphemeralContainer env(List<IoK8sApiCoreV1EnvVar> env)
-
addEnvItem
public IoK8sApiCoreV1EphemeralContainer addEnvItem(IoK8sApiCoreV1EnvVar envItem)
-
getEnv
@Nullable public List<IoK8sApiCoreV1EnvVar> getEnv()
List of environment variables to set in the container. Cannot be updated.- Returns:
- env
-
setEnv
public void setEnv(List<IoK8sApiCoreV1EnvVar> env)
-
envFrom
public IoK8sApiCoreV1EphemeralContainer envFrom(List<IoK8sApiCoreV1EnvFromSource> envFrom)
-
addEnvFromItem
public IoK8sApiCoreV1EphemeralContainer addEnvFromItem(IoK8sApiCoreV1EnvFromSource envFromItem)
-
getEnvFrom
@Nullable public List<IoK8sApiCoreV1EnvFromSource> 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(List<IoK8sApiCoreV1EnvFromSource> envFrom)
-
image
public IoK8sApiCoreV1EphemeralContainer image(String image)
-
getImage
@Nullable public String getImage()
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images- Returns:
- image
-
setImage
public void setImage(String image)
-
imagePullPolicy
public IoK8sApiCoreV1EphemeralContainer imagePullPolicy(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(String imagePullPolicy)
-
lifecycle
public IoK8sApiCoreV1EphemeralContainer lifecycle(IoK8sApiCoreV1Lifecycle lifecycle)
-
getLifecycle
@Nullable public IoK8sApiCoreV1Lifecycle getLifecycle()
Get lifecycle- Returns:
- lifecycle
-
setLifecycle
public void setLifecycle(IoK8sApiCoreV1Lifecycle lifecycle)
-
livenessProbe
public IoK8sApiCoreV1EphemeralContainer livenessProbe(IoK8sApiCoreV1Probe livenessProbe)
-
getLivenessProbe
@Nullable public IoK8sApiCoreV1Probe getLivenessProbe()
Get livenessProbe- Returns:
- livenessProbe
-
setLivenessProbe
public void setLivenessProbe(IoK8sApiCoreV1Probe livenessProbe)
-
name
public IoK8sApiCoreV1EphemeralContainer name(String name)
-
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:
- name
-
setName
public void setName(String name)
-
ports
public IoK8sApiCoreV1EphemeralContainer ports(List<IoK8sApiCoreV1ContainerPort> ports)
-
addPortsItem
public IoK8sApiCoreV1EphemeralContainer addPortsItem(IoK8sApiCoreV1ContainerPort portsItem)
-
getPorts
@Nullable public List<IoK8sApiCoreV1ContainerPort> getPorts()
Ports are not allowed for ephemeral containers.- Returns:
- ports
-
setPorts
public void setPorts(List<IoK8sApiCoreV1ContainerPort> ports)
-
readinessProbe
public IoK8sApiCoreV1EphemeralContainer readinessProbe(IoK8sApiCoreV1Probe readinessProbe)
-
getReadinessProbe
@Nullable public IoK8sApiCoreV1Probe getReadinessProbe()
Get readinessProbe- Returns:
- readinessProbe
-
setReadinessProbe
public void setReadinessProbe(IoK8sApiCoreV1Probe readinessProbe)
-
resources
public IoK8sApiCoreV1EphemeralContainer resources(IoK8sApiCoreV1ResourceRequirements resources)
-
getResources
@Nullable public IoK8sApiCoreV1ResourceRequirements getResources()
Get resources- Returns:
- resources
-
setResources
public void setResources(IoK8sApiCoreV1ResourceRequirements resources)
-
securityContext
public IoK8sApiCoreV1EphemeralContainer securityContext(IoK8sApiCoreV1SecurityContext securityContext)
-
getSecurityContext
@Nullable public IoK8sApiCoreV1SecurityContext getSecurityContext()
Get securityContext- Returns:
- securityContext
-
setSecurityContext
public void setSecurityContext(IoK8sApiCoreV1SecurityContext securityContext)
-
startupProbe
public IoK8sApiCoreV1EphemeralContainer startupProbe(IoK8sApiCoreV1Probe startupProbe)
-
getStartupProbe
@Nullable public IoK8sApiCoreV1Probe getStartupProbe()
Get startupProbe- Returns:
- startupProbe
-
setStartupProbe
public void setStartupProbe(IoK8sApiCoreV1Probe startupProbe)
-
stdin
public IoK8sApiCoreV1EphemeralContainer stdin(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(Boolean stdin)
-
stdinOnce
public IoK8sApiCoreV1EphemeralContainer stdinOnce(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(Boolean stdinOnce)
-
targetContainerName
public IoK8sApiCoreV1EphemeralContainer targetContainerName(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 is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.- Returns:
- targetContainerName
-
setTargetContainerName
public void setTargetContainerName(String targetContainerName)
-
terminationMessagePath
public IoK8sApiCoreV1EphemeralContainer terminationMessagePath(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(String terminationMessagePath)
-
terminationMessagePolicy
public IoK8sApiCoreV1EphemeralContainer terminationMessagePolicy(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(String terminationMessagePolicy)
-
tty
public IoK8sApiCoreV1EphemeralContainer tty(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(Boolean tty)
-
volumeDevices
public IoK8sApiCoreV1EphemeralContainer volumeDevices(List<IoK8sApiCoreV1VolumeDevice> volumeDevices)
-
addVolumeDevicesItem
public IoK8sApiCoreV1EphemeralContainer addVolumeDevicesItem(IoK8sApiCoreV1VolumeDevice volumeDevicesItem)
-
getVolumeDevices
@Nullable public List<IoK8sApiCoreV1VolumeDevice> getVolumeDevices()
volumeDevices is the list of block devices to be used by the container.- Returns:
- volumeDevices
-
setVolumeDevices
public void setVolumeDevices(List<IoK8sApiCoreV1VolumeDevice> volumeDevices)
-
volumeMounts
public IoK8sApiCoreV1EphemeralContainer volumeMounts(List<IoK8sApiCoreV1VolumeMount> volumeMounts)
-
addVolumeMountsItem
public IoK8sApiCoreV1EphemeralContainer addVolumeMountsItem(IoK8sApiCoreV1VolumeMount volumeMountsItem)
-
getVolumeMounts
@Nullable public List<IoK8sApiCoreV1VolumeMount> getVolumeMounts()
Pod volumes to mount into the container's filesystem. Cannot be updated.- Returns:
- volumeMounts
-
setVolumeMounts
public void setVolumeMounts(List<IoK8sApiCoreV1VolumeMount> volumeMounts)
-
workingDir
public IoK8sApiCoreV1EphemeralContainer workingDir(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(String workingDir)
-
-