Containers class

Holds a list of Docker containers.

Constructors

Containers()
Factory ctor
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

containers({bool excludeStopped = false}) List<Container>
returns a list of containers.
existsByContainerId(String containerid, {bool excludeStopped = false}) bool
True if a container with the given containerid exists. By default we include stopped containers. Set excludeStopped to true to ignore stopped containers.
existsByName({required String name, bool excludeStopped = false}) bool
True if a container with the given name exists. By default we include stopped containers. Set excludeStopped to true to ignore stopped containers.
findByContainerId(String containerid, {bool excludeStopped = false}) Container?
Returns the container with the given containerid or null if it doesn't exist. By default we include stopped containers. Set excludeStopped to true to ignore stopped containers.
findByImage(Image image, {bool excludeStopped = false}) List<Container>
Finds the list of containers that where created from the image given by image. By default we include stopped containers.
findByImageid(String? imageid, {bool excludeStopped = false}) List<Container>
Returns a list of containers that were created with the given imageid. If no containers match then an empty list is returned. By default we include stopped containers. Set excludeStopped to true to ignore stopped containers.
findByName(String name, {bool excludeStopped = false}) Container?
Finds and returns the container with given name. Returns null if the container doesn't exist. if excludeStopped is true then exclude containers that are not running.
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