Constructor Detail

Method Detail

• withRawResponse

   abstract WorkServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract WorkServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• retrieve

   CompletableFuture<BetaSelfHostedWork> retrieve(String workId, WorkRetrieveParams 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.

  Retrieve detailed information about a specific work item.

• retrieve

   CompletableFuture<BetaSelfHostedWork> retrieve(String workId, WorkRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<BetaSelfHostedWork> retrieve(WorkRetrieveParams params)

• retrieve

   abstract CompletableFuture<BetaSelfHostedWork> retrieve(WorkRetrieveParams params, RequestOptions requestOptions)

• update

   CompletableFuture<BetaSelfHostedWork> update(String workId, WorkUpdateParams 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.

  Update work item metadata with merge semantics.

• update

   CompletableFuture<BetaSelfHostedWork> update(String workId, WorkUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<BetaSelfHostedWork> update(WorkUpdateParams params)

• update

   abstract CompletableFuture<BetaSelfHostedWork> update(WorkUpdateParams params, RequestOptions requestOptions)

• list

   CompletableFuture<WorkListPageAsync> list(String environmentId)

  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.

  List work items in an environment.

• list

   CompletableFuture<WorkListPageAsync> list(String environmentId, WorkListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<WorkListPageAsync> list(String environmentId, WorkListParams params)

• list

   abstract CompletableFuture<WorkListPageAsync> list(WorkListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<WorkListPageAsync> list(WorkListParams params)

• list

   CompletableFuture<WorkListPageAsync> list(String environmentId, RequestOptions requestOptions)

• ack

   CompletableFuture<BetaSelfHostedWork> ack(String workId, WorkAckParams 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.

  Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' and removing it from the queue.

• ack

   CompletableFuture<BetaSelfHostedWork> ack(String workId, WorkAckParams params, RequestOptions requestOptions)

• ack

   CompletableFuture<BetaSelfHostedWork> ack(WorkAckParams params)

• ack

   abstract CompletableFuture<BetaSelfHostedWork> ack(WorkAckParams params, RequestOptions requestOptions)

• heartbeat

   CompletableFuture<BetaSelfHostedWorkHeartbeatResponse> heartbeat(String workId, WorkHeartbeatParams 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.

• heartbeat

   CompletableFuture<BetaSelfHostedWorkHeartbeatResponse> heartbeat(String workId, WorkHeartbeatParams params, RequestOptions requestOptions)

• heartbeat

   CompletableFuture<BetaSelfHostedWorkHeartbeatResponse> heartbeat(WorkHeartbeatParams params)

• heartbeat

   abstract CompletableFuture<BetaSelfHostedWorkHeartbeatResponse> heartbeat(WorkHeartbeatParams params, RequestOptions requestOptions)

• poll

   CompletableFuture<Optional<BetaSelfHostedWork>> poll(String environmentId)

  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.

  Long poll for work items in the queue.

• poll

   CompletableFuture<Optional<BetaSelfHostedWork>> poll(String environmentId, WorkPollParams params, RequestOptions requestOptions)

• poll

   CompletableFuture<Optional<BetaSelfHostedWork>> poll(String environmentId, WorkPollParams params)

• poll

   abstract CompletableFuture<Optional<BetaSelfHostedWork>> poll(WorkPollParams params, RequestOptions requestOptions)

• poll

   CompletableFuture<Optional<BetaSelfHostedWork>> poll(WorkPollParams params)

• poll

   CompletableFuture<Optional<BetaSelfHostedWork>> poll(String environmentId, RequestOptions requestOptions)

• stats

   CompletableFuture<BetaSelfHostedWorkQueueStats> stats(String environmentId)

  Get statistics about the work queue for an environment.

• stats

   CompletableFuture<BetaSelfHostedWorkQueueStats> stats(String environmentId, WorkStatsParams params, RequestOptions requestOptions)

• stats

   CompletableFuture<BetaSelfHostedWorkQueueStats> stats(String environmentId, WorkStatsParams params)

• stats

   abstract CompletableFuture<BetaSelfHostedWorkQueueStats> stats(WorkStatsParams params, RequestOptions requestOptions)

• stats

   CompletableFuture<BetaSelfHostedWorkQueueStats> stats(WorkStatsParams params)

• stats

   CompletableFuture<BetaSelfHostedWorkQueueStats> stats(String environmentId, RequestOptions requestOptions)

• stop

   CompletableFuture<BetaSelfHostedWork> stop(String workId, WorkStopParams 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.

  Stop a work item, initiating graceful or forced shutdown.

• stop

   CompletableFuture<BetaSelfHostedWork> stop(String workId, WorkStopParams params, RequestOptions requestOptions)

• stop

   CompletableFuture<BetaSelfHostedWork> stop(WorkStopParams params)

• stop

   abstract CompletableFuture<BetaSelfHostedWork> stop(WorkStopParams params, RequestOptions requestOptions)