V1Container (client-java-api 13.0.0 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1Container

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-04T09:55:14.976Z[Etc/UTC]")
public class V1Container
extends Object

A single application container that you want to run within a pod.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ARGS`
`static String`	`SERIALIZED_NAME_COMMAND`
`static String`	`SERIALIZED_NAME_ENV`
`static String`	`SERIALIZED_NAME_ENV_FROM`
`static String`	`SERIALIZED_NAME_IMAGE`
`static String`	`SERIALIZED_NAME_IMAGE_PULL_POLICY`
`static String`	`SERIALIZED_NAME_LIFECYCLE`
`static String`	`SERIALIZED_NAME_LIVENESS_PROBE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_PORTS`
`static String`	`SERIALIZED_NAME_READINESS_PROBE`
`static String`	`SERIALIZED_NAME_RESOURCES`
`static String`	`SERIALIZED_NAME_SECURITY_CONTEXT`
`static String`	`SERIALIZED_NAME_STARTUP_PROBE`
`static String`	`SERIALIZED_NAME_STDIN`
`static String`	`SERIALIZED_NAME_STDIN_ONCE`
`static String`	`SERIALIZED_NAME_TERMINATION_MESSAGE_PATH`
`static String`	`SERIALIZED_NAME_TERMINATION_MESSAGE_POLICY`
`static String`	`SERIALIZED_NAME_TTY`
`static String`	`SERIALIZED_NAME_VOLUME_DEVICES`
`static String`	`SERIALIZED_NAME_VOLUME_MOUNTS`
`static String`	`SERIALIZED_NAME_WORKING_DIR`

Constructor Summary

Constructors
Constructor and Description

V1Container()

Constructors
Constructor and Description
`V1Container()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1Container`	`addArgsItem(String argsItem)`
`V1Container`	`addCommandItem(String commandItem)`
`V1Container`	`addEnvFromItem(V1EnvFromSource envFromItem)`
`V1Container`	`addEnvItem(V1EnvVar envItem)`
`V1Container`	`addPortsItem(V1ContainerPort portsItem)`
`V1Container`	`addVolumeDevicesItem(V1VolumeDevice volumeDevicesItem)`
`V1Container`	`addVolumeMountsItem(V1VolumeMount volumeMountsItem)`
`V1Container`	`args(List<String> args)`
`V1Container`	`command(List<String> command)`
`V1Container`	`env(List<V1EnvVar> env)`
`V1Container`	`envFrom(List<V1EnvFromSource> envFrom)`
`boolean`	`equals(Object o)`
`List<String>`	`getArgs()` Arguments to the entrypoint.
`List<String>`	`getCommand()` Entrypoint array.
`List<V1EnvVar>`	`getEnv()` List of environment variables to set in the container.
`List<V1EnvFromSource>`	`getEnvFrom()` List of sources to populate environment variables in the container.
`String`	`getImage()` Docker image name.
`String`	`getImagePullPolicy()` Image pull policy.
`V1Lifecycle`	`getLifecycle()` Get lifecycle
`V1Probe`	`getLivenessProbe()` Get livenessProbe
`String`	`getName()` Name of the container specified as a DNS_LABEL.
`List<V1ContainerPort>`	`getPorts()` List of ports to expose from the container.
`V1Probe`	`getReadinessProbe()` Get readinessProbe
`V1ResourceRequirements`	`getResources()` Get resources
`V1SecurityContext`	`getSecurityContext()` Get securityContext
`V1Probe`	`getStartupProbe()` Get startupProbe
`Boolean`	`getStdin()` Whether this container should allocate a buffer for stdin in the container runtime.
`Boolean`	`getStdinOnce()` Whether the container runtime should close the stdin channel after it has been opened by a single attach.
`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.
`String`	`getTerminationMessagePolicy()` Indicate how the termination message should be populated.
`Boolean`	`getTty()` Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
`List<V1VolumeDevice>`	`getVolumeDevices()` volumeDevices is the list of block devices to be used by the container.
`List<V1VolumeMount>`	`getVolumeMounts()` Pod volumes to mount into the container's filesystem.
`String`	`getWorkingDir()` Container's working directory.
`int`	`hashCode()`
`V1Container`	`image(String image)`
`V1Container`	`imagePullPolicy(String imagePullPolicy)`
`V1Container`	`lifecycle(V1Lifecycle lifecycle)`
`V1Container`	`livenessProbe(V1Probe livenessProbe)`
`V1Container`	`name(String name)`
`V1Container`	`ports(List<V1ContainerPort> ports)`
`V1Container`	`readinessProbe(V1Probe readinessProbe)`
`V1Container`	`resources(V1ResourceRequirements resources)`
`V1Container`	`securityContext(V1SecurityContext securityContext)`
`void`	`setArgs(List<String> args)`
`void`	`setCommand(List<String> command)`
`void`	`setEnv(List<V1EnvVar> env)`
`void`	`setEnvFrom(List<V1EnvFromSource> envFrom)`
`void`	`setImage(String image)`
`void`	`setImagePullPolicy(String imagePullPolicy)`
`void`	`setLifecycle(V1Lifecycle lifecycle)`
`void`	`setLivenessProbe(V1Probe livenessProbe)`
`void`	`setName(String name)`
`void`	`setPorts(List<V1ContainerPort> ports)`
`void`	`setReadinessProbe(V1Probe readinessProbe)`
`void`	`setResources(V1ResourceRequirements resources)`
`void`	`setSecurityContext(V1SecurityContext securityContext)`
`void`	`setStartupProbe(V1Probe startupProbe)`
`void`	`setStdin(Boolean stdin)`
`void`	`setStdinOnce(Boolean stdinOnce)`
`void`	`setTerminationMessagePath(String terminationMessagePath)`
`void`	`setTerminationMessagePolicy(String terminationMessagePolicy)`
`void`	`setTty(Boolean tty)`
`void`	`setVolumeDevices(List<V1VolumeDevice> volumeDevices)`
`void`	`setVolumeMounts(List<V1VolumeMount> volumeMounts)`
`void`	`setWorkingDir(String workingDir)`
`V1Container`	`startupProbe(V1Probe startupProbe)`
`V1Container`	`stdin(Boolean stdin)`
`V1Container`	`stdinOnce(Boolean stdinOnce)`
`V1Container`	`terminationMessagePath(String terminationMessagePath)`
`V1Container`	`terminationMessagePolicy(String terminationMessagePolicy)`
`String`	`toString()`
`V1Container`	`tty(Boolean tty)`
`V1Container`	`volumeDevices(List<V1VolumeDevice> volumeDevices)`
`V1Container`	`volumeMounts(List<V1VolumeMount> volumeMounts)`
`V1Container`	`workingDir(String workingDir)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ARGS
```
public static final String SERIALIZED_NAME_ARGS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COMMAND
```
public static final String SERIALIZED_NAME_COMMAND
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENV
```
public static final String SERIALIZED_NAME_ENV
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENV_FROM
```
public static final String SERIALIZED_NAME_ENV_FROM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IMAGE
```
public static final String SERIALIZED_NAME_IMAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IMAGE_PULL_POLICY
```
public static final String SERIALIZED_NAME_IMAGE_PULL_POLICY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LIFECYCLE
```
public static final String SERIALIZED_NAME_LIFECYCLE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LIVENESS_PROBE
```
public static final String SERIALIZED_NAME_LIVENESS_PROBE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PORTS
```
public static final String SERIALIZED_NAME_PORTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_READINESS_PROBE
```
public static final String SERIALIZED_NAME_READINESS_PROBE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RESOURCES
```
public static final String SERIALIZED_NAME_RESOURCES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECURITY_CONTEXT
```
public static final String SERIALIZED_NAME_SECURITY_CONTEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STARTUP_PROBE
```
public static final String SERIALIZED_NAME_STARTUP_PROBE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STDIN
```
public static final String SERIALIZED_NAME_STDIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STDIN_ONCE
```
public static final String SERIALIZED_NAME_STDIN_ONCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TERMINATION_MESSAGE_PATH
```
public static final String SERIALIZED_NAME_TERMINATION_MESSAGE_PATH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TERMINATION_MESSAGE_POLICY
```
public static final String SERIALIZED_NAME_TERMINATION_MESSAGE_POLICY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TTY
```
public static final String SERIALIZED_NAME_TTY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VOLUME_DEVICES
```
public static final String SERIALIZED_NAME_VOLUME_DEVICES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VOLUME_MOUNTS
```
public static final String SERIALIZED_NAME_VOLUME_MOUNTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WORKING_DIR
```
public static final String SERIALIZED_NAME_WORKING_DIR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1Container
```
public V1Container()
```
- Method Detail
  - args
```
public V1Container args(List<String> args)
```
  - addArgsItem
```
public V1Container 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
  - setArgs
```
public void setArgs(List<String> args)
```
  - command
```
public V1Container command(List<String> command)
```
  - addCommandItem
```
public V1Container 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
  - setCommand
```
public void setCommand(List<String> command)
```
  - env
```
public V1Container env(List<V1EnvVar> env)
```
  - addEnvItem
```
public V1Container addEnvItem(V1EnvVar envItem)
```
  - getEnv
```
@Nullable
public List<V1EnvVar> getEnv()
```
    List of environment variables to set in the container. Cannot be updated.
    
    Returns:
    
    env
  - setEnv
```
public void setEnv(List<V1EnvVar> env)
```
  - envFrom
```
public V1Container envFrom(List<V1EnvFromSource> envFrom)
```
  - addEnvFromItem
```
public V1Container addEnvFromItem(V1EnvFromSource envFromItem)
```
  - getEnvFrom
```
@Nullable
public List<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:
    
    envFrom
  - setEnvFrom
```
public void setEnvFrom(List<V1EnvFromSource> envFrom)
```
  - image
```
public V1Container image(String image)
```
  - getImage
```
@Nullable
public String getImage()
```
    Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
    
    Returns:
    
    image
  - setImage
```
public void setImage(String image)
```
  - imagePullPolicy
```
public V1Container 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 V1Container lifecycle(V1Lifecycle lifecycle)
```
  - getLifecycle
```
@Nullable
public V1Lifecycle getLifecycle()
```
    Get lifecycle
    
    Returns:
    
    lifecycle
  - setLifecycle
```
public void setLifecycle(V1Lifecycle lifecycle)
```
  - livenessProbe
```
public V1Container livenessProbe(V1Probe livenessProbe)
```
  - getLivenessProbe
```
@Nullable
public V1Probe getLivenessProbe()
```
    Get livenessProbe
    
    Returns:
    
    livenessProbe
  - setLivenessProbe
```
public void setLivenessProbe(V1Probe livenessProbe)
```
  - name
```
public V1Container name(String name)
```
  - getName
```
public String getName()
```
    Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - ports
```
public V1Container ports(List<V1ContainerPort> ports)
```
  - addPortsItem
```
public V1Container addPortsItem(V1ContainerPort portsItem)
```
  - getPorts
```
@Nullable
public List<V1ContainerPort> getPorts()
```
    List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.
    
    Returns:
    
    ports
  - setPorts
```
public void setPorts(List<V1ContainerPort> ports)
```
  - readinessProbe
```
public V1Container readinessProbe(V1Probe readinessProbe)
```
  - getReadinessProbe
```
@Nullable
public V1Probe getReadinessProbe()
```
    Get readinessProbe
    
    Returns:
    
    readinessProbe
  - setReadinessProbe
```
public void setReadinessProbe(V1Probe readinessProbe)
```
  - resources
```
public V1Container resources(V1ResourceRequirements resources)
```
  - getResources
```
@Nullable
public V1ResourceRequirements getResources()
```
    Get resources
    
    Returns:
    
    resources
  - setResources
```
public void setResources(V1ResourceRequirements resources)
```
  - securityContext
```
public V1Container securityContext(V1SecurityContext securityContext)
```
  - getSecurityContext
```
@Nullable
public V1SecurityContext getSecurityContext()
```
    Get securityContext
    
    Returns:
    
    securityContext
  - setSecurityContext
```
public void setSecurityContext(V1SecurityContext securityContext)
```
  - startupProbe
```
public V1Container startupProbe(V1Probe startupProbe)
```
  - getStartupProbe
```
@Nullable
public V1Probe getStartupProbe()
```
    Get startupProbe
    
    Returns:
    
    startupProbe
  - setStartupProbe
```
public void setStartupProbe(V1Probe startupProbe)
```
  - stdin
```
public V1Container 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 V1Container 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)
```
  - terminationMessagePath
```
public V1Container 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 V1Container 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 V1Container 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 V1Container volumeDevices(List<V1VolumeDevice> volumeDevices)
```
  - addVolumeDevicesItem
```
public V1Container addVolumeDevicesItem(V1VolumeDevice volumeDevicesItem)
```
  - getVolumeDevices
```
@Nullable
public List<V1VolumeDevice> getVolumeDevices()
```
    volumeDevices is the list of block devices to be used by the container.
    
    Returns:
    
    volumeDevices
  - setVolumeDevices
```
public void setVolumeDevices(List<V1VolumeDevice> volumeDevices)
```
  - volumeMounts
```
public V1Container volumeMounts(List<V1VolumeMount> volumeMounts)
```
  - addVolumeMountsItem
```
public V1Container addVolumeMountsItem(V1VolumeMount volumeMountsItem)
```
  - getVolumeMounts
```
@Nullable
public List<V1VolumeMount> getVolumeMounts()
```
    Pod volumes to mount into the container's filesystem. Cannot be updated.
    
    Returns:
    
    volumeMounts
  - setVolumeMounts
```
public void setVolumeMounts(List<V1VolumeMount> volumeMounts)
```
  - workingDir
```
public V1Container 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)
```
  - 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

Class V1Container

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ARGS

SERIALIZED_NAME_COMMAND

SERIALIZED_NAME_ENV

SERIALIZED_NAME_ENV_FROM

SERIALIZED_NAME_IMAGE

SERIALIZED_NAME_IMAGE_PULL_POLICY

SERIALIZED_NAME_LIFECYCLE

SERIALIZED_NAME_LIVENESS_PROBE

SERIALIZED_NAME_NAME

SERIALIZED_NAME_PORTS

SERIALIZED_NAME_READINESS_PROBE

SERIALIZED_NAME_RESOURCES

SERIALIZED_NAME_SECURITY_CONTEXT

SERIALIZED_NAME_STARTUP_PROBE

SERIALIZED_NAME_STDIN

SERIALIZED_NAME_STDIN_ONCE

SERIALIZED_NAME_TERMINATION_MESSAGE_PATH

SERIALIZED_NAME_TERMINATION_MESSAGE_POLICY

SERIALIZED_NAME_TTY

SERIALIZED_NAME_VOLUME_DEVICES

SERIALIZED_NAME_VOLUME_MOUNTS

SERIALIZED_NAME_WORKING_DIR

Constructor Detail

V1Container

Method Detail

args

addArgsItem

getArgs

setArgs

command

addCommandItem

getCommand

setCommand

env

addEnvItem

getEnv

setEnv

envFrom

addEnvFromItem

getEnvFrom

setEnvFrom

image

getImage

setImage

imagePullPolicy

getImagePullPolicy

setImagePullPolicy

lifecycle

getLifecycle

setLifecycle

livenessProbe

getLivenessProbe

setLivenessProbe

name

getName

setName

ports

addPortsItem

getPorts

setPorts

readinessProbe

getReadinessProbe

setReadinessProbe

resources

getResources

setResources

securityContext

getSecurityContext

setSecurityContext

startupProbe

getStartupProbe

setStartupProbe

stdin

getStdin