Container (Cloud Run Admin API v1-rev20240426-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.run.v1.model.Container

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Container
extends com.google.api.client.json.GenericJson
```
A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Run Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Container()

Constructors
Constructor and Description
`Container()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Container`	`clone()`
`List<String>`	`getArgs()` Arguments to the entrypoint.
`List<String>`	`getCommand()` Entrypoint array.
`List<EnvVar>`	`getEnv()` List of environment variables to set in the container.
`List<EnvFromSource>`	`getEnvFrom()` Not supported by Cloud Run.
`String`	`getImage()` Required.
`String`	`getImagePullPolicy()` Image pull policy.
`Probe`	`getLivenessProbe()` Periodic probe of container liveness.
`String`	`getName()` Name of the container specified as a DNS_LABEL (RFC 1123).
`List<ContainerPort>`	`getPorts()` List of ports to expose from the container.
`Probe`	`getReadinessProbe()` Not supported by Cloud Run.
`ResourceRequirements`	`getResources()` Compute Resources required by this container.
`SecurityContext`	`getSecurityContext()` Not supported by Cloud Run.
`Probe`	`getStartupProbe()` Startup probe of application within the container.
`String`	`getTerminationMessagePath()` 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.
`List<VolumeMount>`	`getVolumeMounts()` Volume to mount into the container's filesystem.
`String`	`getWorkingDir()` Container's working directory.
`Container`	`set(String fieldName, Object value)`
`Container`	`setArgs(List<String> args)` Arguments to the entrypoint.
`Container`	`setCommand(List<String> command)` Entrypoint array.
`Container`	`setEnv(List<EnvVar> env)` List of environment variables to set in the container.
`Container`	`setEnvFrom(List<EnvFromSource> envFrom)` Not supported by Cloud Run.
`Container`	`setImage(String image)` Required.
`Container`	`setImagePullPolicy(String imagePullPolicy)` Image pull policy.
`Container`	`setLivenessProbe(Probe livenessProbe)` Periodic probe of container liveness.
`Container`	`setName(String name)` Name of the container specified as a DNS_LABEL (RFC 1123).
`Container`	`setPorts(List<ContainerPort> ports)` List of ports to expose from the container.
`Container`	`setReadinessProbe(Probe readinessProbe)` Not supported by Cloud Run.
`Container`	`setResources(ResourceRequirements resources)` Compute Resources required by this container.
`Container`	`setSecurityContext(SecurityContext securityContext)` Not supported by Cloud Run.
`Container`	`setStartupProbe(Probe startupProbe)` Startup probe of application within the container.
`Container`	`setTerminationMessagePath(String terminationMessagePath)` Path at which the file to which the container's termination message will be written is mounted into the container's filesystem.
`Container`	`setTerminationMessagePolicy(String terminationMessagePolicy)` Indicate how the termination message should be populated.
`Container`	`setVolumeMounts(List<VolumeMount> volumeMounts)` Volume to mount into the container's filesystem.
`Container`	`setWorkingDir(String workingDir)` Container's working directory.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Container
```
public Container()
```
- Method Detail
  - getArgs
```
public List<String> getArgs()
```
    Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
    
    Returns:
    
    value or null for none
  - setArgs
```
public Container setArgs(List<String> args)
```
    Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
    
    Parameters:
    
    args - args or null for none
  - getCommand
```
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 are not supported in Cloud Run.
    
    Returns:
    
    value or null for none
  - setCommand
```
public Container setCommand(List<String> command)
```
    Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
    
    Parameters:
    
    command - command or null for none
  - getEnv
```
public List<EnvVar> getEnv()
```
    List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non- secret EnvVar names, the Container will only get the last-declared one.
    
    Returns:
    
    value or null for none
  - setEnv
```
public Container setEnv(List<EnvVar> env)
```
    List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non- secret EnvVar names, the Container will only get the last-declared one.
    
    Parameters:
    
    env - env or null for none
  - getEnvFrom
```
public List<EnvFromSource> getEnvFrom()
```
    Not supported by Cloud Run.
    
    Returns:
    
    value or null for none
  - setEnvFrom
```
public Container setEnvFrom(List<EnvFromSource> envFrom)
```
    Not supported by Cloud Run.
    
    Parameters:
    
    envFrom - envFrom or null for none
  - getImage
```
public String getImage()
```
    Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
    
    Returns:
    
    value or null for none
  - setImage
```
public Container setImage(String image)
```
    Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
    
    Parameters:
    
    image - image or null for none
  - getImagePullPolicy
```
public String getImagePullPolicy()
```
    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
    
    Returns:
    
    value or null for none
  - setImagePullPolicy
```
public Container setImagePullPolicy(String imagePullPolicy)
```
    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
    
    Parameters:
    
    imagePullPolicy - imagePullPolicy or null for none
  - getLivenessProbe
```
public Probe getLivenessProbe()
```
    Periodic probe of container liveness. Container will be restarted if the probe fails.
    
    Returns:
    
    value or null for none
  - setLivenessProbe
```
public Container setLivenessProbe(Probe livenessProbe)
```
    Periodic probe of container liveness. Container will be restarted if the probe fails.
    
    Parameters:
    
    livenessProbe - livenessProbe or null for none
  - getName
```
public String getName()
```
    Name of the container specified as a DNS_LABEL (RFC 1123).
    
    Returns:
    
    value or null for none
  - setName
```
public Container setName(String name)
```
    Name of the container specified as a DNS_LABEL (RFC 1123).
    
    Parameters:
    
    name - name or null for none
  - getPorts
```
public List<ContainerPort> getPorts()
```
    List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
    
    Returns:
    
    value or null for none
  - setPorts
```
public Container setPorts(List<ContainerPort> ports)
```
    List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
    
    Parameters:
    
    ports - ports or null for none
  - getReadinessProbe
```
public Probe getReadinessProbe()
```
    Not supported by Cloud Run.
    
    Returns:
    
    value or null for none
  - setReadinessProbe
```
public Container setReadinessProbe(Probe readinessProbe)
```
    Not supported by Cloud Run.
    
    Parameters:
    
    readinessProbe - readinessProbe or null for none
  - getResources
```
public ResourceRequirements getResources()
```
    Compute Resources required by this container.
    
    Returns:
    
    value or null for none
  - setResources
```
public Container setResources(ResourceRequirements resources)
```
    Compute Resources required by this container.
    
    Parameters:
    
    resources - resources or null for none
  - getSecurityContext
```
public SecurityContext getSecurityContext()
```
    Not supported by Cloud Run.
    
    Returns:
    
    value or null for none
  - setSecurityContext
```
public Container setSecurityContext(SecurityContext securityContext)
```
    Not supported by Cloud Run.
    
    Parameters:
    
    securityContext - securityContext or null for none
  - getStartupProbe
```
public Probe getStartupProbe()
```
    Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
    
    Returns:
    
    value or null for none
  - setStartupProbe
```
public Container setStartupProbe(Probe startupProbe)
```
    Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
    
    Parameters:
    
    startupProbe - startupProbe or null for none
  - getTerminationMessagePath
```
public String getTerminationMessagePath()
```
    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.
    
    Returns:
    
    value or null for none
  - setTerminationMessagePath
```
public Container setTerminationMessagePath(String terminationMessagePath)
```
    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.
    
    Parameters:
    
    terminationMessagePath - terminationMessagePath or null for none
  - getTerminationMessagePolicy
```
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:
    
    value or null for none
  - setTerminationMessagePolicy
```
public Container setTerminationMessagePolicy(String terminationMessagePolicy)
```
    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.
    
    Parameters:
    
    terminationMessagePolicy - terminationMessagePolicy or null for none
  - getVolumeMounts
```
public List<VolumeMount> getVolumeMounts()
```
    Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
    
    Returns:
    
    value or null for none
  - setVolumeMounts
```
public Container setVolumeMounts(List<VolumeMount> volumeMounts)
```
    Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
    
    Parameters:
    
    volumeMounts - volumeMounts or null for none
  - getWorkingDir
```
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.
    
    Returns:
    
    value or null for none
  - setWorkingDir
```
public Container setWorkingDir(String workingDir)
```
    Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
    
    Parameters:
    
    workingDir - workingDir or null for none
  - set
```
public Container set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Container clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Container

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Container

Method Detail

getArgs

setArgs

getCommand

setCommand

getEnv

setEnv

getEnvFrom

setEnvFrom

getImage

setImage

getImagePullPolicy

setImagePullPolicy

getLivenessProbe

setLivenessProbe

getName

setName

getPorts

setPorts

getReadinessProbe

setReadinessProbe

getResources

setResources

getSecurityContext

setSecurityContext

getStartupProbe

setStartupProbe

getTerminationMessagePath

setTerminationMessagePath

getTerminationMessagePolicy

setTerminationMessagePolicy

getVolumeMounts

setVolumeMounts

getWorkingDir

setWorkingDir

set

clone