DockerHostRemote class
Methods
-
buildContainerArgs(String cmd, String imageName, String? version, String containerName, List<String>? ports, String? network, String? hostname, Map<String, String>? environment, Map<String, String>? volumes, bool cleanContainer, String? healthCmd, Duration? healthInterval, int? healthRetries, Duration? healthStartPeriod, Duration? healthTimeout, String? restart)
→ ContainerInfos
-
inherited
-
catContainerLogs(String containerNameOrID, {bool stderr = false, Pattern? waitDataMatcher, Duration? waitDataTimeout, bool waitExit = false, int? desiredExitCode, bool follow = false})
→ Future<String?>
-
Returns the Container logs as
String
.
inherited
-
catServiceLogs(String containerNameOrID, {bool stderr = false, Pattern? waitDataMatcher, Duration? waitDataTimeout, bool waitExit = false, int? desiredExitCode, bool follow = false})
→ Future<String?>
-
Returns a Service logs as
String
.
inherited
-
checkDaemon()
→ Future<bool>
-
Checks if Docker daemon is running.
override
-
close()
→ Future<void>
-
Closes this instance, cleaning any resource.
override
-
command(String command, List<String> args, {bool outputAsLines = true, int? outputLimit, OutputReadyFunction? stdoutReadyFunction, OutputReadyFunction? stderrReadyFunction, OutputReadyType? outputReadyType})
→ Future<DockerProcess?>
-
Executes an arbitrary Docker command with
args
.
override
-
createContainer(String containerName, String imageName, {String? version, List<String>? ports, String? network, String? hostname, Map<String, String>? environment, Map<String, String>? volumes, bool cleanContainer = false, String? healthCmd, Duration? healthInterval, int? healthRetries, Duration? healthStartPeriod, Duration? healthTimeout, String? restart})
→ Future<ContainerInfos?>
-
Creates a Docker containers with
image
and optional version
.
override
-
createService(String serviceName, String imageName, {String? version, int? replicas, List<String>? ports, String? network, String? hostname, Map<String, String>? environment, Map<String, String>? volumes, String? healthCmd, Duration? healthInterval, int? healthRetries, Duration? healthStartPeriod, Duration? healthTimeout})
→ Future<Service?>
-
Creates a Docker service with
serviceName
, image
and optional version
.
Note that the Docker Daemon should be in Swarm mode.
inherited
-
createTempFile(String content)
→ Future<String?>
-
Creates a temporary file.
-
deleteTempFile(String filePath)
→ Future<bool>
-
Deletes a temporary
filePath
.
-
exec(String containerName, String command, List<String> args, {bool outputAsLines = true, int? outputLimit, OutputReadyFunction? stdoutReadyFunction, OutputReadyFunction? stderrReadyFunction, OutputReadyType? outputReadyType})
→ Future<DockerProcess?>
-
Executes a
command
inside containerName
with args
.
override
-
execAnConfirmExit(String containerName, String command, List<String> args, int desiredExitCode)
→ Future<bool>
-
Calls exec than
waitExit
.
inherited
-
execAndWaitExit(String containerName, String command, List<String> args, {int? desiredExitCode})
→ Future<int?>
-
Calls exec than
waitExit
.
inherited
-
execAndWaitStderr(String containerName, String command, List<String> args, {int? desiredExitCode})
→ Future<Output?>
-
Calls exec than
waitStderr
.
inherited
-
execAndWaitStderrAsString(String containerName, String command, List<String> args, {bool trim = false, int? desiredExitCode, Pattern? dataMatcher})
→ Future<String?>
-
Calls execAndWaitStderrAsString and returns Output.asString.
inherited
-
execAndWaitStdout(String containerName, String command, List<String> args, {int? desiredExitCode})
→ Future<Output?>
-
Calls exec than
waitStdout
.
inherited
-
execAndWaitStdoutAsString(String containerName, String command, List<String> args, {bool trim = false, int? desiredExitCode, Pattern? dataMatcher})
→ Future<String?>
-
Calls execAndWaitStdoutAsString and returns Output.asString.
inherited
-
execWhich(String containerName, String commandName, {bool ignoreCache = false, String? def})
→ Future<String?>
-
Call POSIX
which
command.
Calls exec with command which
and args commandName
.
Caches response than returns the executable path for commandName
.
inherited
-
formulaExec(String formulaName, String functionName, [List? arguments, Map<String, dynamic>? fields])
→ Future
-
Executes a formula function.
override
-
getContainerIDByName(String? name)
→ Future<String?>
-
Returns a Docker container ID with
name
.
override
-
getFormulaClassName(String formulaName)
→ Future<String?>
-
Returns the class name of a formula.
override
-
getFormulaFields(String formulaName)
→ Future<Map<String, Object>>
-
Returns the formula fields/properties.
override
-
getProcessByInstanceID(int instanceID)
→ DockerProcess?
-
Returns a DockerProcess with
instanceID
.
override
-
getRunnerByInstanceID(int instanceID)
→ DockerRunnerRemote?
-
Returns a DockerRunner with
instanceID
.
override
-
getRunnerByName(String name)
→ DockerRunner?
-
Returns a DockerRunner with
name
.
override
-
getRunnersInstanceIDs()
→ List<int>
-
Returns a List<int> of DockerRunner
instanceID
.
override
-
getRunnersNames()
→ List<String>
-
Returns a List<String> of DockerRunner
name
.
override
-
getServiceIDByName(String name)
→ Future<String?>
-
Returns a Docker service ID with
name
.
inherited
-
initialize(DockerCommander dockerCommander)
→ Future<bool>
-
Initializes instance.
override
-
isContainerARunner(String containerName)
→ bool
-
Returns
true
containerName
has a DockerRunner.
-
isContainerRunnerRunning(String containerName)
→ bool
-
Returns
true
if DockerRunner of containerName
is running.
-
isContainerRunning(String containerName)
→ Future<bool>
-
Returns if
containerName
is running (checks at Docker Daemon).
inherited
-
listFormulasFunctions(String formulaName)
→ Future<List<String>>
-
List the functions of a formula.
override
-
listFormulasNames()
→ Future<List<String>>
-
List the current available formulas names.
override
-
listServiceTasks(String name)
→ Future<List<ServiceTaskInfos>?>
-
Returns a list of ServiceTaskInfos of a service by
serviceName
.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
openContainerLogs(String containerNameOrID)
→ Future<DockerProcess?>
-
Opens a Container logs, by
containerNameOrID
.
inherited
-
openServiceLogs(String serviceNameOrTask)
→ Future<DockerProcess?>
-
Opens a Service logs, by
serviceNameOrTask
.
inherited
-
processGetOutput(int instanceID, int realOffset, bool stderr)
→ Future<OutputSync?>
-
-
processWaitExit(int instanceID, [Duration? timeout])
→ Future<int?>
-
-
processWaitReady(int instanceID)
→ Future<bool>
-
-
removeContainer(String containerNameOrID, {bool force = false})
→ Future<bool>
-
Removes a container by
containerNameOrID
.
inherited
-
removeService(String name)
→ Future<bool>
-
Removes a service from the Swarm cluster by
name
.
inherited
-
run(String image, {String? version, List<String>? imageArgs, String? containerName, List<String>? ports, String? network, String? hostname, Map<String, String>? environment, Map<String, String>? volumes, bool cleanContainer = true, String? healthCmd, Duration? healthInterval, int? healthRetries, Duration? healthStartPeriod, Duration? healthTimeout, String? restart, bool outputAsLines = true, int? outputLimit, OutputReadyFunction? stdoutReadyFunction, OutputReadyFunction? stderrReadyFunction, OutputReadyType? outputReadyType})
→ Future<DockerRunner?>
-
Runs a Docker containers with
image
and optional version
.
override
-
startContainer(String? containerNameOrID)
→ Future<bool>
-
Starts a container by
containerNameOrID
.
inherited
-
stopByInstanceID(int instanceID, {Duration? timeout})
→ Future<bool>
-
Stops a container by
instanceID
.
inherited
-
stopByName(String? name, {Duration? timeout})
→ Future<bool>
-
Stops a container by
name
.
override
-
stopRunners()
→ Future<void>
-
Stops all DockerRunner returned by getRunnersInstanceIDs.
inherited
-
toString()
→ String
-
A string representation of this object.
override