CheckpointManager
Lists, resolves, waits for, and deletes tenant checkpoints.
Sync · Async counterpart:
AsyncCheckpointManager
CheckpointManager declaration
Section titled “CheckpointManager declaration”class CheckpointManager(_SdkOwnedHandle):CheckpointManager access
Section titled “CheckpointManager access”This type is created by the SDK; do not construct it directly.
manager = client.checkpointsCheckpointManager methods
Section titled “CheckpointManager methods”list()
Section titled “list()”List tenant checkpoints, optionally including system checkpoints.
def list(*, include_system: bool = False) -> list[CheckpointInfo]Parameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
include_system | bool | False | Include system-provided checkpoints. |
Returns
Section titled “Returns”list[CheckpointInfo]
Resolve a checkpoint by UUID or display name.
def get(id: str) -> CheckpointInfoParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
id | str | — | Resource UUID or display name. |
Returns
Section titled “Returns”CheckpointInfo
wait_until_ready()
Section titled “wait_until_ready()”Wait until a checkpoint is ready or has failed.
def wait_until_ready(id: str, *, timeout: float = 240.0, poll_interval: float = 0.5) -> CheckpointInfoParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
id | str | — | Resource UUID or display name. |
timeout | float | 240.0 | Maximum operation time in seconds. |
poll_interval | float | 0.5 | Seconds between status checks. |
Returns
Section titled “Returns”CheckpointInfo
delete()
Section titled “delete()”Delete a checkpoint by UUID or display name.
def delete(id: str) -> NoneParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
id | str | — | Resource UUID or display name. |