Container class

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.

Constructors

Container({Input<List<String>>? args, Input<List<String>>? command, Input<List<EnvVar>>? env, Input<List<EnvFromSource>>? envFrom, required Input<String> image, Input<String>? imagePullPolicy, Input<Probe>? livenessProbe, Input<String>? name, Input<List<ContainerPort>>? ports, Input<Probe>? readinessProbe, Input<ResourceRequirements>? resources, Input<SecurityContext>? securityContext, Input<Probe>? startupProbe, Input<String>? terminationMessagePath, Input<String>? terminationMessagePolicy, Input<List<VolumeMount>>? volumeMounts, Input<String>? workingDir})
Creates a new Container. 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. 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. 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. envFrom Not supported by Cloud Run. image Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed. imagePullPolicy Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. livenessProbe Periodic probe of container liveness. Container will be restarted if the probe fails. name Name of the container specified as a DNS_LABEL (RFC 1123). 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. readinessProbe Not supported by Cloud Run. resources Compute Resources required by this container. securityContext Not supported by Cloud Run. 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. 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. 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. volumeMounts Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. workingDir Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
const
Container.fromMap(Map<String, dynamic> map)
factory

Properties

args → Input<List<String>>?
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
final
command → Input<List<String>>?
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.
final
env → Input<List<EnvVar>>?
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.
final
envFrom → Input<List<EnvFromSource>>?
Not supported by Cloud Run.
final
hashCode → int
The hash code for this object.
no setterinherited
image → Input<String>
Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
final
imagePullPolicy → Input<String>?
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
final
livenessProbe → Input<Probe>?
Periodic probe of container liveness. Container will be restarted if the probe fails.
final
name → Input<String>?
Name of the container specified as a DNS_LABEL (RFC 1123).
final
ports → Input<List<ContainerPort>>?
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.
final
readinessProbe → Input<Probe>?
Not supported by Cloud Run.
final
resources → Input<ResourceRequirements>?
Compute Resources required by this container.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityContext → Input<SecurityContext>?
Not supported by Cloud Run.
final
startupProbe → Input<Probe>?
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.
final
terminationMessagePath → Input<String>?
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.
final
terminationMessagePolicy → Input<String>?
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.
final
volumeMounts → Input<List<VolumeMount>>?
Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
final
workingDir → Input<String>?
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited