Dagger.Env (dagger v0.19.4)

View Source

Dagger.Env

Summary

Types

t()

Functions

id(env)

A unique identifier for this Env.

input(env, name)

Retrieves an input binding by name

inputs(env)

Returns all input bindings provided to the environment

output(env, name)

Retrieves an output binding by name

outputs(env)

Returns all declared output bindings for the environment

with_address_input(env, name, value, description)

Create or update a binding of type Address in the environment

with_address_output(env, name, description)

Declare a desired Address output to be assigned in the environment

with_cache_volume_input(env, name, value, description)

Create or update a binding of type CacheVolume in the environment

with_cache_volume_output(env, name, description)

Declare a desired CacheVolume output to be assigned in the environment

with_changeset_input(env, name, value, description)

Create or update a binding of type Changeset in the environment

with_changeset_output(env, name, description)

Declare a desired Changeset output to be assigned in the environment

with_cloud_input(env, name, value, description)

Create or update a binding of type Cloud in the environment

with_cloud_output(env, name, description)

Declare a desired Cloud output to be assigned in the environment

with_container_input(env, name, value, description)

Create or update a binding of type Container in the environment

with_container_output(env, name, description)

Declare a desired Container output to be assigned in the environment

with_current_module(env)

Installs the current module into the environment, exposing its functions to the model

with_directory_input(env, name, value, description)

Create or update a binding of type Directory in the environment

with_directory_output(env, name, description)

Declare a desired Directory output to be assigned in the environment

with_env_file_input(env, name, value, description)

Create or update a binding of type EnvFile in the environment

with_env_file_output(env, name, description)

Declare a desired EnvFile output to be assigned in the environment

with_env_input(env, name, value, description)

Create or update a binding of type Env in the environment

with_env_output(env, name, description)

Declare a desired Env output to be assigned in the environment

with_file_input(env, name, value, description)

Create or update a binding of type File in the environment

with_file_output(env, name, description)

Declare a desired File output to be assigned in the environment

with_git_ref_input(env, name, value, description)

Create or update a binding of type GitRef in the environment

with_git_ref_output(env, name, description)

Declare a desired GitRef output to be assigned in the environment

with_git_repository_input(env, name, value, description)

Create or update a binding of type GitRepository in the environment

with_git_repository_output(env, name, description)

Declare a desired GitRepository output to be assigned in the environment

with_json_value_input(env, name, value, description)

Create or update a binding of type JSONValue in the environment

with_json_value_output(env, name, description)

Declare a desired JSONValue output to be assigned in the environment

with_module(env, module)

Installs a module into the environment, exposing its functions to the model

with_module_config_client_input(env, name, value, description)

Create or update a binding of type ModuleConfigClient in the environment

with_module_config_client_output(env, name, description)

Declare a desired ModuleConfigClient output to be assigned in the environment

with_module_input(env, name, value, description)

Create or update a binding of type Module in the environment

with_module_output(env, name, description)

Declare a desired Module output to be assigned in the environment

with_module_source_input(env, name, value, description)

Create or update a binding of type ModuleSource in the environment

with_module_source_output(env, name, description)

Declare a desired ModuleSource output to be assigned in the environment

with_search_result_input(env, name, value, description)

Create or update a binding of type SearchResult in the environment

with_search_result_output(env, name, description)

Declare a desired SearchResult output to be assigned in the environment

with_search_submatch_input(env, name, value, description)

Create or update a binding of type SearchSubmatch in the environment

with_search_submatch_output(env, name, description)

Declare a desired SearchSubmatch output to be assigned in the environment

with_secret_input(env, name, value, description)

Create or update a binding of type Secret in the environment

with_secret_output(env, name, description)

Declare a desired Secret output to be assigned in the environment

with_service_input(env, name, value, description)

Create or update a binding of type Service in the environment

with_service_output(env, name, description)

Declare a desired Service output to be assigned in the environment

with_socket_input(env, name, value, description)

Create or update a binding of type Socket in the environment

with_socket_output(env, name, description)

Declare a desired Socket output to be assigned in the environment

with_string_input(env, name, value, description)

Provides a string input binding to the environment

with_string_output(env, name, description)

Declares a desired string output binding

with_workspace(env, workspace)

Returns a new environment with the provided workspace

without_outputs(env)

Returns a new environment without any outputs

workspace(env)

Types

t()

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

Functions

id(env)

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

A unique identifier for this Env.

input(env, name)

@spec input(t(), String.t()) :: Dagger.Binding.t()

Retrieves an input binding by name

inputs(env)

@spec inputs(t()) :: {:ok, [Dagger.Binding.t()]} | {:error, term()}

Returns all input bindings provided to the environment

output(env, name)

@spec output(t(), String.t()) :: Dagger.Binding.t()

Retrieves an output binding by name

outputs(env)

@spec outputs(t()) :: {:ok, [Dagger.Binding.t()]} | {:error, term()}

Returns all declared output bindings for the environment

with_address_input(env, name, value, description)

@spec with_address_input(t(), String.t(), Dagger.Address.t(), String.t()) :: t()

Create or update a binding of type Address in the environment

with_address_output(env, name, description)

@spec with_address_output(t(), String.t(), String.t()) :: t()

Declare a desired Address output to be assigned in the environment

with_cache_volume_input(env, name, value, description)

@spec with_cache_volume_input(t(), String.t(), Dagger.CacheVolume.t(), String.t()) ::
  t()

Create or update a binding of type CacheVolume in the environment

with_cache_volume_output(env, name, description)

@spec with_cache_volume_output(t(), String.t(), String.t()) :: t()

Declare a desired CacheVolume output to be assigned in the environment

with_changeset_input(env, name, value, description)

@spec with_changeset_input(t(), String.t(), Dagger.Changeset.t(), String.t()) :: t()

Create or update a binding of type Changeset in the environment

with_changeset_output(env, name, description)

@spec with_changeset_output(t(), String.t(), String.t()) :: t()

Declare a desired Changeset output to be assigned in the environment

with_cloud_input(env, name, value, description)

@spec with_cloud_input(t(), String.t(), Dagger.Cloud.t(), String.t()) :: t()

Create or update a binding of type Cloud in the environment

with_cloud_output(env, name, description)

@spec with_cloud_output(t(), String.t(), String.t()) :: t()

Declare a desired Cloud output to be assigned in the environment

with_container_input(env, name, value, description)

@spec with_container_input(t(), String.t(), Dagger.Container.t(), String.t()) :: t()

Create or update a binding of type Container in the environment

with_container_output(env, name, description)

@spec with_container_output(t(), String.t(), String.t()) :: t()

Declare a desired Container output to be assigned in the environment

with_current_module(env)

@spec with_current_module(t()) :: t()

Installs the current module into the environment, exposing its functions to the model

Contextual path arguments will be populated using the environment's workspace.

with_directory_input(env, name, value, description)

@spec with_directory_input(t(), String.t(), Dagger.Directory.t(), String.t()) :: t()

Create or update a binding of type Directory in the environment

with_directory_output(env, name, description)

@spec with_directory_output(t(), String.t(), String.t()) :: t()

Declare a desired Directory output to be assigned in the environment

with_env_file_input(env, name, value, description)

@spec with_env_file_input(t(), String.t(), Dagger.EnvFile.t(), String.t()) :: t()

Create or update a binding of type EnvFile in the environment

with_env_file_output(env, name, description)

@spec with_env_file_output(t(), String.t(), String.t()) :: t()

Declare a desired EnvFile output to be assigned in the environment

with_env_input(env, name, value, description)

@spec with_env_input(t(), String.t(), t(), String.t()) :: t()

Create or update a binding of type Env in the environment

with_env_output(env, name, description)

@spec with_env_output(t(), String.t(), String.t()) :: t()

Declare a desired Env output to be assigned in the environment

with_file_input(env, name, value, description)

@spec with_file_input(t(), String.t(), Dagger.File.t(), String.t()) :: t()

Create or update a binding of type File in the environment

with_file_output(env, name, description)

@spec with_file_output(t(), String.t(), String.t()) :: t()

Declare a desired File output to be assigned in the environment

with_git_ref_input(env, name, value, description)

@spec with_git_ref_input(t(), String.t(), Dagger.GitRef.t(), String.t()) :: t()

Create or update a binding of type GitRef in the environment

with_git_ref_output(env, name, description)

@spec with_git_ref_output(t(), String.t(), String.t()) :: t()

Declare a desired GitRef output to be assigned in the environment

with_git_repository_input(env, name, value, description)

@spec with_git_repository_input(t(), String.t(), Dagger.GitRepository.t(), String.t()) ::
  t()

Create or update a binding of type GitRepository in the environment

with_git_repository_output(env, name, description)

@spec with_git_repository_output(t(), String.t(), String.t()) :: t()

Declare a desired GitRepository output to be assigned in the environment

with_json_value_input(env, name, value, description)

@spec with_json_value_input(t(), String.t(), Dagger.JSONValue.t(), String.t()) :: t()

Create or update a binding of type JSONValue in the environment

with_json_value_output(env, name, description)

@spec with_json_value_output(t(), String.t(), String.t()) :: t()

Declare a desired JSONValue output to be assigned in the environment

with_module(env, module)

@spec with_module(t(), Dagger.Module.t()) :: t()

Installs a module into the environment, exposing its functions to the model

Contextual path arguments will be populated using the environment's workspace.

with_module_config_client_input(env, name, value, description)

@spec with_module_config_client_input(
  t(),
  String.t(),
  Dagger.ModuleConfigClient.t(),
  String.t()
) :: t()

Create or update a binding of type ModuleConfigClient in the environment

with_module_config_client_output(env, name, description)

@spec with_module_config_client_output(t(), String.t(), String.t()) :: t()

Declare a desired ModuleConfigClient output to be assigned in the environment

with_module_input(env, name, value, description)

@spec with_module_input(t(), String.t(), Dagger.Module.t(), String.t()) :: t()

Create or update a binding of type Module in the environment

with_module_output(env, name, description)

@spec with_module_output(t(), String.t(), String.t()) :: t()

Declare a desired Module output to be assigned in the environment

with_module_source_input(env, name, value, description)

@spec with_module_source_input(t(), String.t(), Dagger.ModuleSource.t(), String.t()) ::
  t()

Create or update a binding of type ModuleSource in the environment

with_module_source_output(env, name, description)

@spec with_module_source_output(t(), String.t(), String.t()) :: t()

Declare a desired ModuleSource output to be assigned in the environment

with_search_result_input(env, name, value, description)

@spec with_search_result_input(t(), String.t(), Dagger.SearchResult.t(), String.t()) ::
  t()

Create or update a binding of type SearchResult in the environment

with_search_result_output(env, name, description)

@spec with_search_result_output(t(), String.t(), String.t()) :: t()

Declare a desired SearchResult output to be assigned in the environment

with_search_submatch_input(env, name, value, description)

@spec with_search_submatch_input(
  t(),
  String.t(),
  Dagger.SearchSubmatch.t(),
  String.t()
) :: t()

Create or update a binding of type SearchSubmatch in the environment

with_search_submatch_output(env, name, description)

@spec with_search_submatch_output(t(), String.t(), String.t()) :: t()

Declare a desired SearchSubmatch output to be assigned in the environment

with_secret_input(env, name, value, description)

@spec with_secret_input(t(), String.t(), Dagger.Secret.t(), String.t()) :: t()

Create or update a binding of type Secret in the environment

with_secret_output(env, name, description)

@spec with_secret_output(t(), String.t(), String.t()) :: t()

Declare a desired Secret output to be assigned in the environment

with_service_input(env, name, value, description)

@spec with_service_input(t(), String.t(), Dagger.Service.t(), String.t()) :: t()

Create or update a binding of type Service in the environment

with_service_output(env, name, description)

@spec with_service_output(t(), String.t(), String.t()) :: t()

Declare a desired Service output to be assigned in the environment

with_socket_input(env, name, value, description)

@spec with_socket_input(t(), String.t(), Dagger.Socket.t(), String.t()) :: t()

Create or update a binding of type Socket in the environment

with_socket_output(env, name, description)

@spec with_socket_output(t(), String.t(), String.t()) :: t()

Declare a desired Socket output to be assigned in the environment

with_string_input(env, name, value, description)

@spec with_string_input(t(), String.t(), String.t(), String.t()) :: t()

Provides a string input binding to the environment

with_string_output(env, name, description)

@spec with_string_output(t(), String.t(), String.t()) :: t()

Declares a desired string output binding

with_workspace(env, workspace)

@spec with_workspace(t(), Dagger.Directory.t()) :: t()

Returns a new environment with the provided workspace

without_outputs(env)

@spec without_outputs(t()) :: t()

Returns a new environment without any outputs

workspace(env)

@spec workspace(t()) :: Dagger.Directory.t()