Dagger.Address (dagger v0.20.1)

Copy Markdown View Source

A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.

Summary

Types

t()

Functions

container(address)

Load a container from the address.

directory(address, optional_args \\ [])

Load a directory from the address.

file(address, optional_args \\ [])

Load a file from the address.

git_ref(address)

Load a git ref (branch, tag or commit) from the address.

git_repository(address)

Load a git repository from the address.

id(address)

A unique identifier for this Address.

secret(address)

Load a secret from the address.

service(address)

Load a service from the address.

socket(address)

Load a local socket from the address.

value(address)

The address value

Types

t()

@type t() :: %Dagger.Address{client: term(), query_builder: term()}

Functions

container(address)

@spec container(t()) :: Dagger.Container.t()

Load a container from the address.

directory(address, optional_args \\ [])

@spec directory(t(),
  exclude: [String.t()],
  include: [String.t()],
  gitignore: boolean() | nil,
  no_cache: boolean() | nil
) :: Dagger.Directory.t()

Load a directory from the address.

file(address, optional_args \\ [])

@spec file(t(),
  exclude: [String.t()],
  include: [String.t()],
  gitignore: boolean() | nil,
  no_cache: boolean() | nil
) :: Dagger.File.t()

Load a file from the address.

git_ref(address)

@spec git_ref(t()) :: Dagger.GitRef.t()

Load a git ref (branch, tag or commit) from the address.

git_repository(address)

@spec git_repository(t()) :: Dagger.GitRepository.t()

Load a git repository from the address.

id(address)

@spec id(t()) :: {:ok, Dagger.AddressID.t()} | {:error, term()}

A unique identifier for this Address.

secret(address)

@spec secret(t()) :: Dagger.Secret.t()

Load a secret from the address.

service(address)

@spec service(t()) :: Dagger.Service.t()

Load a service from the address.

socket(address)

@spec socket(t()) :: Dagger.Socket.t()

Load a local socket from the address.

value(address)

@spec value(t()) :: {:ok, String.t()} | {:error, term()}

The address value