View Source Dagger.Client (dagger v0.8.8)
Query
Link to this section Summary
Functions
Constructs a cache volume for a given cache key.
Checks if the current Dagger Engine is compatible with an SDK's required version.
Loads a container from ID.
The FunctionCall context that the SDK caller is currently executing in. If the caller is not currently executing in a function, this will return an error.
The module currently being served in the session, if any.
The default platform of the builder.
Load a directory by ID. No argument produces an empty directory.
Loads a file by ID.
Load a function by ID
Load GeneratedCode by ID, or create a new one if id is unset.
Queries a git repository.
Queries the host environment.
Returns a file containing an http remote url content.
Load a module by ID, or create a new one if id is unset.
Create a new function from the provided definition.
Creates a named sub-pipeline.
Loads a secret from its ID.
Sets a secret given a user defined name to its plaintext and returns the secret. The plaintext value is limited to a size of 128000 bytes.
Loads a socket by its ID.
Optional Arguments
id
-
Link to this section Types
Link to this section Functions
@spec cache_volume(t(), Dagger.String.t()) :: Dagger.CacheVolume.t()
Constructs a cache volume for a given cache key.
required-arguments
Required Arguments
key
- A string identifier to target this cache volume (e.g., "modules-cache").
@spec check_version_compatibility(t(), Dagger.String.t()) :: {:ok, Dagger.Boolean.t()} | {:error, term()}
Checks if the current Dagger Engine is compatible with an SDK's required version.
required-arguments
Required Arguments
version
- The SDK's required version.
@spec container( t(), keyword() ) :: Dagger.Container.t()
Loads a container from ID.
Null ID returns an empty container (scratch). Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder's host.
optional-arguments
Optional Arguments
id
-platform
-
@spec current_function_call(t()) :: Dagger.FunctionCall.t()
The FunctionCall context that the SDK caller is currently executing in. If the caller is not currently executing in a function, this will return an error.
@spec current_module(t()) :: {:ok, Dagger.Module.t() | nil} | {:error, term()}
The module currently being served in the session, if any.
@spec default_platform(t()) :: {:ok, Dagger.Platform.t()} | {:error, term()}
The default platform of the builder.
@spec directory( t(), keyword() ) :: Dagger.Directory.t()
Load a directory by ID. No argument produces an empty directory.
optional-arguments
Optional Arguments
id
-
@spec file(t(), Dagger.FileID.t()) :: {:ok, Dagger.File.t() | nil} | {:error, term()}
Loads a file by ID.
required-arguments
Required Arguments
id
-
@spec function(t(), Dagger.Function.t()) :: Dagger.Function.t()
Load a function by ID
required-arguments
Required Arguments
id
-
@spec generated_code( t(), keyword() ) :: Dagger.GeneratedCode.t()
Load GeneratedCode by ID, or create a new one if id is unset.
optional-arguments
Optional Arguments
id
-
@spec git(t(), Dagger.String.t(), keyword()) :: Dagger.GitRepository.t()
Queries a git repository.
required-arguments
Required Arguments
url
- Url of the git repository. Can be formatted as https://{host}/{owner}/{repo}, git@{host}/{owner}/{repo} Suffix ".git" is optional.
optional-arguments
Optional Arguments
keep_git_dir
- Set to true to keep .git directory.experimental_service_host
- A service which must be started before the repo is fetched.
@spec host(t()) :: Dagger.Host.t()
Queries the host environment.
@spec http(t(), Dagger.String.t(), keyword()) :: Dagger.File.t()
Returns a file containing an http remote url content.
required-arguments
Required Arguments
url
- HTTP url to get the content from (e.g., "https://docs.dagger.io").
optional-arguments
Optional Arguments
experimental_service_host
- A service which must be started before the URL is fetched.
@spec module( t(), keyword() ) :: Dagger.Module.t()
Load a module by ID, or create a new one if id is unset.
optional-arguments
Optional Arguments
id
-
@spec new_function(t(), Dagger.String.t(), Dagger.TypeDef.t()) :: Dagger.Function.t()
Create a new function from the provided definition.
required-arguments
Required Arguments
name
-return_type
-
@spec pipeline(t(), Dagger.String.t(), keyword()) :: t()
Creates a named sub-pipeline.
required-arguments
Required Arguments
name
- Pipeline name.
optional-arguments
Optional Arguments
description
- Pipeline description.labels
- Pipeline labels.
@spec secret(t(), Dagger.SecretID.t()) :: Dagger.Secret.t()
Loads a secret from its ID.
required-arguments
Required Arguments
id
-
@spec set_secret(t(), Dagger.String.t(), Dagger.String.t()) :: Dagger.Secret.t()
Sets a secret given a user defined name to its plaintext and returns the secret. The plaintext value is limited to a size of 128000 bytes.
required-arguments
Required Arguments
name
- The user defined name for this secretplaintext
- The plaintext of the secret
@spec socket( t(), keyword() ) :: Dagger.Socket.t()
Loads a socket by its ID.
optional-arguments
Optional Arguments
id
-
@spec type_def( t(), keyword() ) :: Dagger.TypeDef.t()
optional-arguments
Optional Arguments
id
-