View Source Dagger.FunctionArg (dagger v0.14.0)

An argument accepted by a function.

This is a specification for an argument at function definition time, not an argument passed at function call time.

Summary

Functions

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

A default value to use for this argument when not explicitly set by the caller, if any.

A doc string for the argument, if any.

A unique identifier for this FunctionArg.

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

The name of the argument in lowerCamelCase format.

The location of this arg declaration.

The type of the argument.

Types

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

Functions

Link to this function

default_path(function_arg)

View Source
@spec default_path(t()) :: {:ok, String.t()} | {:error, term()}

Only applies to arguments of type File or Directory. If the argument is not set, load it from the given path in the context directory

Link to this function

default_value(function_arg)

View Source
@spec default_value(t()) :: {:ok, Dagger.JSON.t()} | {:error, term()}

A default value to use for this argument when not explicitly set by the caller, if any.

Link to this function

description(function_arg)

View Source
@spec description(t()) :: {:ok, String.t()} | {:error, term()}

A doc string for the argument, if any.

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

A unique identifier for this FunctionArg.

@spec ignore(t()) :: {:ok, [String.t()]} | {:error, term()}

Only applies to arguments of type Directory. The ignore patterns are applied to the input directory, and matching entries are filtered out, in a cache-efficient manner.

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

The name of the argument in lowerCamelCase format.

Link to this function

source_map(function_arg)

View Source
@spec source_map(t()) :: Dagger.SourceMap.t()

The location of this arg declaration.

@spec type_def(t()) :: Dagger.TypeDef.t()

The type of the argument.