Formula class abstract

An operational procedure that manages a piece of software on a node (install / update / start / stop / restart / uninstall / verify).

Formulas are the unit of work a preset composes. They are expected to be idempotent (running install when already installed should report changed: false), cross-platform aware (inspect FormulaContext.platform), and safe to validate at any time via validate.

Implementers

Constructors

Formula()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
spec FormulaSpec
The static metadata describing this formula.
no setter

Methods

install(FormulaContext context) Future<FormulaResult>
Installs the managed software.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
restart(FormulaContext context) Future<FormulaResult>
Restarts the managed service.
run(FormulaAction action, FormulaContext context) Future<FormulaResult>
Dispatches the given action to the matching method.
start(FormulaContext context) Future<FormulaResult>
Starts the managed service.
status(FormulaContext context) Future<FormulaStatusReport>
Reports what this formula manages, as it currently stands on the node.
stop(FormulaContext context) Future<FormulaResult>
Stops the managed service.
toString() String
A string representation of this object.
inherited
uninstall(FormulaContext context) Future<FormulaResult>
Uninstalls the managed software.
update(FormulaContext context) Future<FormulaResult>
Updates the managed software toward the target version.
validate(FormulaContext context) Future<ValidationResult>
Validates that the managed software is present and healthy.

Operators

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