WorkflowCheckpoint class
Declared script checkpoint metadata used for tooling and replay boundaries.
Unlike FlowStep, a WorkflowCheckpoint does not define execution logic.
Script workflows execute their run(...) body directly and use these
declarations only for manifests, introspection, encoding, and replay
metadata.
Constructors
-
WorkflowCheckpoint({required String name, bool autoVersion = false, String? title, Object? valueEncoder(Object? value)?, Object? valueDecoder(Object? value)?, WorkflowStepKind kind = WorkflowStepKind.task, Iterable<
String> taskNames = const [], Map<String, Object?> ? metadata}) - Creates declared checkpoint metadata for a script workflow.
-
WorkflowCheckpoint.fromJson(Map<
String, Object?> json) -
Rehydrates declared checkpoint metadata from serialized JSON.
factory
Properties
- autoVersion → bool
-
Whether to auto-version repeated checkpoint executions.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- kind → WorkflowStepKind
-
Checkpoint kind classification.
final
-
metadata
→ Map<
String, Object?> ? -
Optional metadata associated with the checkpoint.
final
- name → String
-
Checkpoint name used for persistence and replay.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
taskNames
→ List<
String> -
Task names associated with this checkpoint.
final
- title → String
-
Human-friendly checkpoint title exposed for introspection.
final
Methods
-
decodeValue(
Object? payload) → Object? - Decodes a persisted checkpoint value back into the author-facing type.
-
encodeValue(
Object? value) → Object? - Encodes a checkpoint value before it is persisted.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> - Serializes checkpoint metadata for workflow introspection.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
typed<
T> ({required String name, required PayloadCodec< T> valueCodec, bool autoVersion = false, String? title, WorkflowStepKind kind = WorkflowStepKind.task, Iterable<String> taskNames = const [], Map<String, Object?> ? metadata}) → WorkflowCheckpoint -
Creates checkpoint metadata backed by a typed
valueCodec.