Class WorkHeartbeatParams
-
- All Implemented Interfaces:
-
com.anthropic.core.Params
public final class WorkHeartbeatParams implements Params
Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.
Record a heartbeat for a work item to maintain the lease.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWorkHeartbeatParams.BuilderA builder for WorkHeartbeatParams.
-
Method Summary
Modifier and Type Method Description final StringenvironmentId()final Optional<String>workId()final Optional<Long>desiredTtlSeconds()Desired TTL in seconds final Optional<String>expectedLastHeartbeat()Expected last_heartbeat for conditional update (optimistic concurrency). final Optional<List<AnthropicBeta>>betas()Optional header to specify the beta version(s) you want to use. final Map<String, JsonValue>_additionalBodyProperties()Additional body properties to send with the request. final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final WorkHeartbeatParams.BuildertoBuilder()final Optional<Map<String, JsonValue>>_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static WorkHeartbeatParams.Builderbuilder()Returns a mutable builder for constructing an instance of WorkHeartbeatParams. -
-
Method Detail
-
environmentId
final String environmentId()
-
desiredTtlSeconds
final Optional<Long> desiredTtlSeconds()
Desired TTL in seconds
-
expectedLastHeartbeat
final Optional<String> expectedLastHeartbeat()
Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match.
-
betas
final Optional<List<AnthropicBeta>> betas()
Optional header to specify the beta version(s) you want to use.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
Additional body properties to send with the request.
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final WorkHeartbeatParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static WorkHeartbeatParams.Builder builder()
Returns a mutable builder for constructing an instance of WorkHeartbeatParams.
The following fields are required:
.environmentId()
-
-
-
-