Interface CheckpointMetadata

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

Properties

parents source step writes

Properties

parents

parents: Record<string, string>

The IDs of the parent checkpoints. Mapping from checkpoint namespace to checkpoint ID.

source

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

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.

step

step: number

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

writes

writes: null | Record<string, unknown>

The writes that were made between the previous checkpoint and this one. Mapping from node name to writes emitted by that node.

Settings

Member Visibility

Theme

On This Page

parentssourcestepwrites