ContainerConfig class

The container-level configuration as stored in the image or overridden at run time.

This corresponds to Docker's Config sub-object in the inspect response.

Constructors

ContainerConfig({String? hostname, String? domainname, String? user, bool? attachStdin, bool? attachStdout, bool? attachStderr, Map<String, dynamic>? exposedPorts, bool? tty, bool? openStdin, bool? stdinOnce, List<String>? env, List<String>? cmd, ContainerHealthcheck? healthcheck, bool? argsEscaped, String? image, Map<String, dynamic>? volumes, String? workingDir, List<String>? entrypoint, bool? networkDisabled, String? macAddress, List<String>? onBuild, Map<String, String>? labels, String? stopSignal, int? stopTimeout, List<String>? shell})
Creates a ContainerConfig with the given fields.
const
ContainerConfig.fromJson(Map<String, dynamic> json)
Deserialises a ContainerConfig from Docker's JSON representation.
factory

Properties

argsEscaped → bool?
Windows-only: whether shell argument escaping is applied to cmd.
final
attachStderr → bool?
Whether stderr is attached.
final
attachStdin → bool?
Whether stdin is attached at container creation.
final
attachStdout → bool?
Whether stdout is attached.
final
cmd → List<String>?
Default command run by the container.
final
domainname → String?
Domain name set inside the container.
final
entrypoint → List<String>?
Entrypoint command.
final
env → List<String>?
Environment variables as KEY=value strings.
final
exposedPorts → Map<String, dynamic>?
Ports that the container exposes. Keys are 'port/proto' strings; values are always empty objects {}.
final
hashCode → int
The hash code for this object.
no setterinherited
healthcheck → ContainerHealthcheck?
Health-check configuration embedded in the image.
final
hostname → String?
Hostname set inside the container.
final
image → String?
Image name or ID that the container was created from.
final
labels → Map<String, String>?
Labels applied to the container.
final
macAddress → String?
MAC address of the container's primary network interface (legacy field).
final
networkDisabled → bool?
Whether networking is disabled for the container.
final
onBuild → List<String>?
List of ONBUILD trigger instructions.
final
openStdin → bool?
Whether stdin is kept open even if not attached.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shell → List<String>?
Shell used for shell-form CMD/RUN instructions.
final
stdinOnce → bool?
Whether stdin is closed after one attach.
final
stopSignal → String?
Signal to send to the main process to stop the container (e.g. 'SIGTERM').
final
stopTimeout → int?
Timeout in seconds before a SIGKILL is sent after stopSignal.
final
tty → bool?
Whether a pseudo-TTY is allocated for the container.
final
user → String?
User that runs the container's main process.
final
volumes → Map<String, dynamic>?
Volume mount points declared in the image. Keys are container paths; values are always empty objects.
final
workingDir → String?
Working directory for the container's main process.
final

Methods

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

Operators

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