Constructor Detail

Method Detail

• withRawResponse

   abstract DeploymentServiceAsync.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• create

   CompletableFuture<Void> create(DeploymentCreateParams params)

  Creates a deployment for an existing project by fetching repository files from GitHub and uploading them to the hosting provider. Use ref to deploy a branch, tag, or commit other than the project default branch.

• create

   abstract CompletableFuture<Void> create(DeploymentCreateParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Void> retrieve(String id, DeploymentRetrieveParams params)

  Returns deployment details for one project in the authenticated organization. Set includeLogs=true to include recent build output in the response.

• retrieve

   CompletableFuture<Void> retrieve(String id, DeploymentRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Void> retrieve(DeploymentRetrieveParams params)

• retrieve

   abstract CompletableFuture<Void> retrieve(DeploymentRetrieveParams params, RequestOptions requestOptions)

• list

   CompletableFuture<Void> list(DeploymentListParams params)

  Lists recent deployments for one project in the authenticated organization. Use the optional filters to narrow results by target or deployment state.

• list

   abstract CompletableFuture<Void> list(DeploymentListParams params, RequestOptions requestOptions)

• cancel

   CompletableFuture<Void> cancel(String id, DeploymentCancelParams params)

  Cancels a running deployment after verifying that the referenced project belongs to the authenticated organization. Use this when a build is stuck, misconfigured, or no longer needed.

• cancel

   CompletableFuture<Void> cancel(String id, DeploymentCancelParams params, RequestOptions requestOptions)

• cancel

   CompletableFuture<Void> cancel(DeploymentCancelParams params)

• cancel

   abstract CompletableFuture<Void> cancel(DeploymentCancelParams params, RequestOptions requestOptions)

• createFromFiles

   CompletableFuture<Void> createFromFiles()

  Create a deployment from raw file contents (for Thurgood sandbox deployments)

• createFromFiles

   abstract CompletableFuture<Void> createFromFiles(DeploymentCreateFromFilesParams params, RequestOptions requestOptions)

• createFromFiles

   CompletableFuture<Void> createFromFiles(DeploymentCreateFromFilesParams params)

• createFromFiles

   CompletableFuture<Void> createFromFiles(RequestOptions requestOptions)

• getLogs

   CompletableFuture<Void> getLogs(String id, DeploymentGetLogsParams params)

  Returns build and runtime log events for a deployment after verifying access to the owning project. Use this when you need detailed output for a failed or in-progress build.

• getLogs

   CompletableFuture<Void> getLogs(String id, DeploymentGetLogsParams params, RequestOptions requestOptions)

• getLogs

   CompletableFuture<Void> getLogs(DeploymentGetLogsParams params)

• getLogs

   abstract CompletableFuture<Void> getLogs(DeploymentGetLogsParams params, RequestOptions requestOptions)

• getStatus

   CompletableFuture<Void> getStatus(String id)

  Returns the current status of a deployment without fetching full build logs. Use this endpoint for lightweight polling while a deployment is building or waiting to become ready.

• getStatus

   CompletableFuture<Void> getStatus(String id, DeploymentGetStatusParams params, RequestOptions requestOptions)

• getStatus

   CompletableFuture<Void> getStatus(String id, DeploymentGetStatusParams params)

• getStatus

   abstract CompletableFuture<Void> getStatus(DeploymentGetStatusParams params, RequestOptions requestOptions)

• getStatus

   CompletableFuture<Void> getStatus(DeploymentGetStatusParams params)

• getStatus

   CompletableFuture<Void> getStatus(String id, RequestOptions requestOptions)

• stream

   CompletableFuture<Void> stream(String id, DeploymentStreamParams params)

  Stream real-time deployment progress events via Server-Sent Events

• stream

   CompletableFuture<Void> stream(String id, DeploymentStreamParams params, RequestOptions requestOptions)

• stream

   CompletableFuture<Void> stream(DeploymentStreamParams params)

• stream

   abstract CompletableFuture<Void> stream(DeploymentStreamParams params, RequestOptions requestOptions)