ExDaytona.Api.WarmPools (ex_daytona v0.4.0)

API calls for all endpoints tagged WarmPools.

Summary

Functions

create_warm_pool(connection, create_warm_pool, opts \\ [])

Create a warm pool

delete_warm_pool(connection, id, opts \\ [])

Delete a warm pool

list_warm_pools(connection, opts \\ [])

List warm pools for the organization

update_warm_pool(connection, id, update_warm_pool, opts \\ [])

Update a warm pool size

Functions

create_warm_pool(connection, create_warm_pool, opts \\ [])

@spec create_warm_pool(
  Tesla.Env.client(),
  ExDaytona.Model.CreateWarmPool.t(),
  keyword()
) ::
  {:ok, ExDaytona.Model.WarmPool.t()} | {:error, Tesla.Env.t()}

Create a warm pool

Parameters

connection (ExDaytona.Connection): Connection to server
create_warm_pool (CreateWarmPool):
opts (keyword): Optional parameters
- :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

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

delete_warm_pool(connection, id, opts \\ [])

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

Delete a warm pool

Parameters

connection (ExDaytona.Connection): Connection to server
id (String.t): Warm pool ID
opts (keyword): Optional parameters
- :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

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

list_warm_pools(connection, opts \\ [])

@spec list_warm_pools(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [ExDaytona.Model.WarmPool.t()]} | {:error, Tesla.Env.t()}

List warm pools for the organization

Parameters

connection (ExDaytona.Connection): Connection to server
opts (keyword): Optional parameters
- :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

{:ok, [%WarmPool{}, ...]} on success
{:error, Tesla.Env.t} on failure

update_warm_pool(connection, id, update_warm_pool, opts \\ [])

@spec update_warm_pool(
  Tesla.Env.client(),
  String.t(),
  ExDaytona.Model.UpdateWarmPool.t(),
  keyword()
) ::
  {:ok, ExDaytona.Model.WarmPool.t()} | {:error, Tesla.Env.t()}

Update a warm pool size

Parameters

connection (ExDaytona.Connection): Connection to server
id (String.t): Warm pool ID
update_warm_pool (UpdateWarmPool):
opts (keyword): Optional parameters
- :"X-Daytona-Organization-ID" (String.t): Use with JWT to specify the organization ID

Returns

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