Interface CheckpointMetadata

interface CheckpointMetadata {
    source: "update" | "input" | "loop";
    step: number;
    writes: null | Record<string, unknown>;
}

Index

Properties

source step writes

Properties

source

source: "update" | "input" | "loop"

step

step: number

The source of the checkpoint.

"input": The checkpoint was created from an input to invoke/stream/batch.
"loop": The checkpoint was created from inside the pregel loop.
"update": The checkpoint was created from a manual state update.

writes

writes: null | Record<string, unknown>

The step number of the checkpoint. -1 for the first "input" checkpoint. 0 for the first "loop" checkpoint. ... for the nth checkpoint afterwards.