Step class

It represents the step responsible for the sequential process.

This step has a single task and is processed in sequential.

Constructors

Step({required String name, required Task<Task> task, FutureOr<bool> precondition(ExecutionContext context)?, dynamic onStarted(ExecutionContext context)?, dynamic onSucceeded(ExecutionContext context)?, dynamic onError(ExecutionContext context, dynamic error, StackTrace stackTrace)?, dynamic onCompleted(ExecutionContext context)?, SkipConfiguration? skipConfig, RetryConfiguration? retryConfig, List<BaseStep> branchesOnSucceeded = const [], List<BaseStep> branchesOnFailed = const [], List<BaseStep> branchesOnCompleted = const []})
Returns the new instance of Step.
Step.ofShutdown({String name = 'Shutdown Step'})
Returns the new instance of Step.

Properties

branches List<Branch<BaseStep>>
The branches
finalinherited
hasBranch bool
Returns true if this event has branch, otherwise false.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hasRetryPolicy bool
Returns true if this event has retry policy, otherwise false.
no setterinherited
hasSkipPolicy bool
Returns true if this event has skip policy, otherwise false.
no setterinherited
name String
The name
finalinherited
onCompleted → (dynamic Function(ExecutionContext context)?)
The callback when this process is completed (regardless of success and failure)
finalinherited
onError → (dynamic Function(ExecutionContext context, dynamic error, StackTrace stackTrace)?)
The callback when this process is stopped due to exception
finalinherited
onStarted → (dynamic Function(ExecutionContext context)?)
The callback when this process is started
finalinherited
onSucceeded → (dynamic Function(ExecutionContext context)?)
The callback when this process is succeeded
finalinherited
precondition → (FutureOr<bool> Function(ExecutionContext context)?)
The precondition
finalinherited
retryPolicy → RetryPolicy?
The retry policy
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
skipPolicy → SkipPolicy?
The skip policy
finalinherited
tasks List
Returns the tasks.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shouldLaunch(ExecutionContext context) Future<bool>
Returns true if this event can launch, otherwise false.
inherited
toString() String
A string representation of this object.
inherited

Operators

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