io.enterpriseai.resources.CheckpointsClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/CheckpointsClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class CheckpointsClient
Run checkpoints.
Constructor CheckpointsClient
CheckpointsClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
CheckpointsClient.create
JsonNode create(String runId, Object body)
Save a checkpoint. Saves a state of the run with the next sequence number and the current step sequence, so the run can later resume from it. Needs tenant_admin, developer or agent. Refused with 409 run_finished on a run succeeded or cancelled. Emits checkpoint.created; audited as run.checkpoint.
Route: /v1/runs/{run_id}/checkpoints (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
runId | String | yes | Identifier (UUID) of the run. | |
body | Object | yes | State to save and optional label. |
Returns: JsonNode. Decoded JSON answer of the operation "Save a checkpoint".
Raises: the typed errors of the transport (Errors).
CheckpointsClient.create
JsonNode create(String runId, Object body, RequestOptions options)
Save a checkpoint. Saves a state of the run with the next sequence number and the current step sequence, so the run can later resume from it. Needs tenant_admin, developer or agent. Refused with 409 run_finished on a run succeeded or cancelled. Emits checkpoint.created; audited as run.checkpoint.
Route: /v1/runs/{run_id}/checkpoints (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
runId | String | yes | Identifier (UUID) of the run. | |
body | Object | yes | State to save and optional label. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Save a checkpoint".
Raises: the typed errors of the transport (Errors).
CheckpointsClient.get
JsonNode get(String id)
Get a checkpoint. Returns one checkpoint: run, sequence number, step sequence at save time, label and saved state. 404 checkpoint_not_found.
Route: /v1/checkpoints/{checkpoint_id} (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the checkpoint. |
Returns: JsonNode. Decoded JSON answer of the operation "Get a checkpoint".
Raises: the typed errors of the transport (Errors).
CheckpointsClient.list
JsonNode list(String runId)
List the checkpoints of a run. Checkpoints of the run in sequence order. One page only. 404 run_not_found.
Route: /v1/runs/{run_id}/checkpoints (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
runId | String | yes | Identifier (UUID) of the run. |
Returns: JsonNode. Decoded JSON answer of the operation "List the checkpoints of a run".
Raises: the typed errors of the transport (Errors).