ExDaytona.Api.DockerRegistry (ex_daytona v0.4.0)

API calls for all endpoints tagged DockerRegistry.

Summary

Functions

create_registry(connection, create_docker_registry, opts \\ [])

Create registry

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

Delete registry

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

Get registry

get_transient_push_access(connection, opts \\ [])

Get temporary registry access for pushing snapshots

list_registries(connection, opts \\ [])

List registries

update_registry(connection, id, update_docker_registry, opts \\ [])

Update registry

Functions

create_registry(connection, create_docker_registry, opts \\ [])

@spec create_registry(
  Tesla.Env.client(),
  ExDaytona.Model.CreateDockerRegistry.t(),
  keyword()
) ::
  {:ok, ExDaytona.Model.DockerRegistry.t()} | {:error, Tesla.Env.t()}

Create registry

Parameters

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

Returns

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

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

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

Delete registry

Parameters

connection (ExDaytona.Connection): Connection to server
id (String.t): ID of the docker registry
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

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

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

Get registry

Parameters

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

Returns

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

get_transient_push_access(connection, opts \\ [])

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

Get temporary registry access for pushing snapshots

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
- :regionId (String.t): ID of the region where the snapshot will be available (defaults to organization default region)

Returns

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

list_registries(connection, opts \\ [])

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

List registries

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, [%DockerRegistry{}, ...]} on success
{:error, Tesla.Env.t} on failure

update_registry(connection, id, update_docker_registry, opts \\ [])

@spec update_registry(
  Tesla.Env.client(),
  String.t(),
  ExDaytona.Model.UpdateDockerRegistry.t(),
  keyword()
) :: {:ok, ExDaytona.Model.DockerRegistry.t()} | {:error, Tesla.Env.t()}

Update registry

Parameters

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

Returns

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