Skip to content

CheckpointManager

Lists, resolves, waits for, and deletes tenant checkpoints.

Sync · Async counterpart: AsyncCheckpointManager

class CheckpointManager(_SdkOwnedHandle):

This type is created by the SDK; do not construct it directly.

manager = client.checkpoints

List tenant checkpoints, optionally including system checkpoints.

def list(*, include_system: bool = False) -> list[CheckpointInfo]
NameTypeDefaultDescription
include_systemboolFalseInclude system-provided checkpoints.
  • list[CheckpointInfo]

Resolve a checkpoint by UUID or display name.

def get(id: str) -> CheckpointInfo
NameTypeDefaultDescription
idstrResource UUID or display name.
  • CheckpointInfo

Wait until a checkpoint is ready or has failed.

def wait_until_ready(id: str, *, timeout: float = 240.0, poll_interval: float = 0.5) -> CheckpointInfo
NameTypeDefaultDescription
idstrResource UUID or display name.
timeoutfloat240.0Maximum operation time in seconds.
poll_intervalfloat0.5Seconds between status checks.
  • CheckpointInfo

Delete a checkpoint by UUID or display name.

def delete(id: str) -> None
NameTypeDefaultDescription
idstrResource UUID or display name.