ExDaytona.Api.Info (ex_daytona v0.2.0)

Copy Markdown View Source

API calls for all endpoints tagged Info.

Summary

Functions

Get user home directory Get the current user home directory path.

Get version Get the current daemon version

Get working directory Get the current working directory path. This is default directory used for running commands.

Functions

get_user_home_dir(connection, opts \\ [])

@spec get_user_home_dir(
  Tesla.Env.client(),
  keyword()
) :: {:ok, ExDaytona.Model.UserHomeDirResponse.t()} | {:error, Tesla.Env.t()}

Get user home directory Get the current user home directory path.

Parameters

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

Returns

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

get_version(connection, opts \\ [])

@spec get_version(
  Tesla.Env.client(),
  keyword()
) :: {:ok, %{optional(String.t()) => String.t()}} | {:error, Tesla.Env.t()}

Get version Get the current daemon version

Parameters

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

Returns

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

get_work_dir(connection, opts \\ [])

@spec get_work_dir(
  Tesla.Env.client(),
  keyword()
) :: {:ok, ExDaytona.Model.WorkDirResponse.t()} | {:error, Tesla.Env.t()}

Get working directory Get the current working directory path. This is default directory used for running commands.

Parameters

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

Returns

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