kubernetes_asyncio.client.models.v1_ephemeral_container module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_ephemeral_container.V1EphemeralContainer(args=None, command=None, env=None, env_from=None, image=None, image_pull_policy=None, lifecycle=None, liveness_probe=None, name=None, ports=None, readiness_probe=None, resize_policy=None, resources=None, restart_policy=None, restart_policy_rules=None, security_context=None, startup_probe=None, stdin=None, stdin_once=None, target_container_name=None, termination_message_path=None, termination_message_policy=None, tty=None, volume_devices=None, volume_mounts=None, working_dir=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property args

Gets the args of this V1EphemeralContainer. # noqa: E501

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 # noqa: E501

Returns:

The args of this V1EphemeralContainer. # noqa: E501

Return type:

list[str]

attribute_map = {'args': 'args', 'command': 'command', 'env': 'env', 'env_from': 'envFrom', 'image': 'image', 'image_pull_policy': 'imagePullPolicy', 'lifecycle': 'lifecycle', 'liveness_probe': 'livenessProbe', 'name': 'name', 'ports': 'ports', 'readiness_probe': 'readinessProbe', 'resize_policy': 'resizePolicy', 'resources': 'resources', 'restart_policy': 'restartPolicy', 'restart_policy_rules': 'restartPolicyRules', 'security_context': 'securityContext', 'startup_probe': 'startupProbe', 'stdin': 'stdin', 'stdin_once': 'stdinOnce', 'target_container_name': 'targetContainerName', 'termination_message_path': 'terminationMessagePath', 'termination_message_policy': 'terminationMessagePolicy', 'tty': 'tty', 'volume_devices': 'volumeDevices', 'volume_mounts': 'volumeMounts', 'working_dir': 'workingDir'}

property command

Gets the command of this V1EphemeralContainer. # noqa: E501

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 # noqa: E501

Returns:

The command of this V1EphemeralContainer. # noqa: E501

Return type:

list[str]

property env

Gets the env of this V1EphemeralContainer. # noqa: E501

List of environment variables to set in the container. Cannot be updated. # noqa: E501

Returns:

The env of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1EnvVar]

property env_from

Gets the env_from of this V1EphemeralContainer. # noqa: E501

List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except ‘=’. 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. # noqa: E501

Returns:

The env_from of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1EnvFromSource]

property image

Gets the image of this V1EphemeralContainer. # noqa: E501

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images # noqa: E501

Returns:

The image of this V1EphemeralContainer. # noqa: E501

Return type:

str

property image_pull_policy

Gets the image_pull_policy of this V1EphemeralContainer. # noqa: E501

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 # noqa: E501

Returns:

The image_pull_policy of this V1EphemeralContainer. # noqa: E501

Return type:

str

property lifecycle

Gets the lifecycle of this V1EphemeralContainer. # noqa: E501

Returns:

The lifecycle of this V1EphemeralContainer. # noqa: E501

Return type:

V1Lifecycle

property liveness_probe

Gets the liveness_probe of this V1EphemeralContainer. # noqa: E501

Returns:

The liveness_probe of this V1EphemeralContainer. # noqa: E501

Return type:

V1Probe

property name

Gets the name of this V1EphemeralContainer. # noqa: E501

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. # noqa: E501

Returns:

The name of this V1EphemeralContainer. # noqa: E501

Return type:

str

openapi_types = {'args': 'list[str]', 'command': 'list[str]', 'env': 'list[V1EnvVar]', 'env_from': 'list[V1EnvFromSource]', 'image': 'str', 'image_pull_policy': 'str', 'lifecycle': 'V1Lifecycle', 'liveness_probe': 'V1Probe', 'name': 'str', 'ports': 'list[V1ContainerPort]', 'readiness_probe': 'V1Probe', 'resize_policy': 'list[V1ContainerResizePolicy]', 'resources': 'V1ResourceRequirements', 'restart_policy': 'str', 'restart_policy_rules': 'list[V1ContainerRestartRule]', 'security_context': 'V1SecurityContext', 'startup_probe': 'V1Probe', 'stdin': 'bool', 'stdin_once': 'bool', 'target_container_name': 'str', 'termination_message_path': 'str', 'termination_message_policy': 'str', 'tty': 'bool', 'volume_devices': 'list[V1VolumeDevice]', 'volume_mounts': 'list[V1VolumeMount]', 'working_dir': 'str'}

property ports

Gets the ports of this V1EphemeralContainer. # noqa: E501

Ports are not allowed for ephemeral containers. # noqa: E501

Returns:

The ports of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1ContainerPort]

property readiness_probe

Gets the readiness_probe of this V1EphemeralContainer. # noqa: E501

Returns:

The readiness_probe of this V1EphemeralContainer. # noqa: E501

Return type:

V1Probe

property resize_policy

Gets the resize_policy of this V1EphemeralContainer. # noqa: E501

Resources resize policy for the container. # noqa: E501

Returns:

The resize_policy of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1ContainerResizePolicy]

property resources

Gets the resources of this V1EphemeralContainer. # noqa: E501

Returns:

The resources of this V1EphemeralContainer. # noqa: E501

Return type:

V1ResourceRequirements

property restart_policy

Gets the restart_policy of this V1EphemeralContainer. # noqa: E501

Restart policy for the container to manage the restart behavior of each container within a pod. You cannot set this field on ephemeral containers. # noqa: E501

Returns:

The restart_policy of this V1EphemeralContainer. # noqa: E501

Return type:

str

property restart_policy_rules

Gets the restart_policy_rules of this V1EphemeralContainer. # noqa: E501

Represents a list of rules to be checked to determine if the container should be restarted on exit. You cannot set this field on ephemeral containers. # noqa: E501

Returns:

The restart_policy_rules of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1ContainerRestartRule]

property security_context

Gets the security_context of this V1EphemeralContainer. # noqa: E501

Returns:

The security_context of this V1EphemeralContainer. # noqa: E501

Return type:

V1SecurityContext

property startup_probe

Gets the startup_probe of this V1EphemeralContainer. # noqa: E501

Returns:

The startup_probe of this V1EphemeralContainer. # noqa: E501

Return type:

V1Probe

property stdin

Gets the stdin of this V1EphemeralContainer. # noqa: E501

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. # noqa: E501

Returns:

The stdin of this V1EphemeralContainer. # noqa: E501

Return type:

bool

property stdin_once

Gets the stdin_once of this V1EphemeralContainer. # noqa: E501

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 # noqa: E501

Returns:

The stdin_once of this V1EphemeralContainer. # noqa: E501

Return type:

bool

property target_container_name

Gets the target_container_name of this V1EphemeralContainer. # noqa: E501

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. # noqa: E501

Returns:

The target_container_name of this V1EphemeralContainer. # noqa: E501

Return type:

str

property termination_message_path

Gets the termination_message_path of this V1EphemeralContainer. # noqa: E501

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. # noqa: E501

Returns:

The termination_message_path of this V1EphemeralContainer. # noqa: E501

Return type:

str

property termination_message_policy

Gets the termination_message_policy of this V1EphemeralContainer. # noqa: E501

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. # noqa: E501

Returns:

The termination_message_policy of this V1EphemeralContainer. # noqa: E501

Return type:

str

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tty

Gets the tty of this V1EphemeralContainer. # noqa: E501

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false. # noqa: E501

Returns:

The tty of this V1EphemeralContainer. # noqa: E501

Return type:

bool

property volume_devices

Gets the volume_devices of this V1EphemeralContainer. # noqa: E501

volumeDevices is the list of block devices to be used by the container. # noqa: E501

Returns:

The volume_devices of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1VolumeDevice]

property volume_mounts

Gets the volume_mounts of this V1EphemeralContainer. # noqa: E501

Pod volumes to mount into the container’s filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. # noqa: E501

Returns:

The volume_mounts of this V1EphemeralContainer. # noqa: E501

Return type:

list[V1VolumeMount]

property working_dir

Gets the working_dir of this V1EphemeralContainer. # noqa: E501

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. # noqa: E501

Returns:

The working_dir of this V1EphemeralContainer. # noqa: E501

Return type:

str