RuntimeCheckpointManager
Creates, lists, and deletes checkpoints for a runtime.
Sync · Async counterpart:
AsyncRuntimeCheckpointManager
RuntimeCheckpointManager declaration
Section titled “RuntimeCheckpointManager declaration”class RuntimeCheckpointManager(_SdkOwnedHandle):RuntimeCheckpointManager access
Section titled “RuntimeCheckpointManager access”This type is created by the SDK; do not construct it directly.
manager = runtime.checkpointsRuntimeCheckpointManager methods
Section titled “RuntimeCheckpointManager methods”create()
Section titled “create()”Create a checkpoint from this runtime and optionally wait until ready.
def create(kind: str = 'full', name: str | None = None, *, wait: bool = True, timeout: float = 240.0, poll_interval: float = 0.5) -> CheckpointInfoParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
kind | str | 'full' | Checkpoint kind. The public API currently accepts "full". |
name | str | None | None | Optional display name for the checkpoint. |
wait | bool | True | Wait for the checkpoint to become ready before returning. |
timeout | float | 240.0 | Maximum number of seconds to wait for readiness. |
poll_interval | float | 0.5 | Seconds between readiness checks. |
Returns
Section titled “Returns”CheckpointInfo— Metadata for the created checkpoint.
Examples
Section titled “Examples”>>> checkpoint = runtime.checkpoints.create(name="worker-ready")>>> restored = client.runtimes.create(checkpoint_id=checkpoint.id)list()
Section titled “list()”List checkpoints created from this runtime.
def list() -> list[CheckpointInfo]Returns
Section titled “Returns”list[CheckpointInfo]
delete()
Section titled “delete()”Delete one of this runtime’s checkpoints.
def delete(id: str) -> NoneParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
id | str | — | Resource UUID or display name. |