ExDaytona.Api.Health (ex_daytona v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged Health.

Summary

Functions

check(connection, opts \\ [])
live(connection, opts \\ [])

Functions

check(connection, opts \\ [])

@spec check(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExDaytona.Model.Check200Response.t()}
  | {:ok, ExDaytona.Model.Check503Response.t()}
  | {:error, Tesla.Env.t()}

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExDaytona.Model.Check200Response.t} on success
  • {:error, Tesla.Env.t} on failure

live(connection, opts \\ [])

@spec live(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Parameters

  • connection (ExDaytona.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure