Index | API

A

Argument — Class in namespace Dagger\Attribute
AbstractClient — Class in namespace Dagger\Client
AbstractId — Class in namespace Dagger\Client
AbstractInputObject — Class in namespace Dagger\Client
AbstractObject — Class in namespace Dagger\Client
AbstractScalar — Class in namespace Dagger\Client
Container::asService() — Method in class Container: Turn the container into a Service.
Container::asTarball() — Method in class Container: Returns a File representing the container serialized to a tarball.
Directory::asModule() — Method in class Directory: Load the directory as a Dagger module source
Directory::asModuleSource() — Method in class Directory: Load the directory as a Dagger module source
EngineCacheEntry::activelyUsed() — Method in class EngineCacheEntry: Whether the cache entry is actively being used.
Function_::args() — Method in class Function_: Arguments accepted by the function, if any.
ModuleSource::asModule() — Method in class ModuleSource: Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation
ModuleSource::asString() — Method in class ModuleSource: A human readable ref string representation of this module source.
TypeDef::asEnum() — Method in class TypeDef: If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null.
TypeDef::asInput() — Method in class TypeDef: If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.
TypeDef::asInterface() — Method in class TypeDef: If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.
TypeDef::asList() — Method in class TypeDef: If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.
TypeDef::asObject() — Method in class TypeDef: If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.
TypeDef::asScalar() — Method in class TypeDef: If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null.

B

BuildArg — Class in namespace Dagger: Key value object that represents a build argument.
Client::builtinContainer() — Method in class Client: Retrieves a container builtin to the engine.
Container::build() — Method in class Container: Initializes this container from a Dockerfile build.
GitRepository::branch() — Method in class GitRepository: Returns details of a branch.

C

CacheVolume — Class in namespace Dagger: A directory whose contents persist across runs.
CacheVolumeId — Class in namespace Dagger: The CacheVolumeID scalar type represents an identifier for an object of type CacheVolume.
Client — Class in namespace Dagger: The root of the DAG.
Client::cacheVolume() — Method in class Client: Constructs a cache volume for a given cache key.
Client::container() — Method in class Client: Creates a scratch container.
Client::currentFunctionCall() — Method in class Client: The FunctionCall context that the SDK caller is currently executing in.
Client::currentModule() — Method in class Client: The module currently being served in the session, if any.
Client::currentTypeDefs() — Method in class Client: The TypeDef representations of the objects currently being served in the session.
$ AbstractClient#client — Property in class AbstractClient
Connection — Class in namespace Dagger
$ Connection#client — Property in class Connection
Connection::createGraphQlClient() — Method in class Connection
Connection::connect() — Method in class Connection
Connection::close() — Method in class Connection
Container — Class in namespace Dagger: An OCI-compatible container, also known as a Docker container.
ContainerId — Class in namespace Dagger: The ContainerID scalar type represents an identifier for an object of type Container.
CurrentModule — Class in namespace Dagger: Reflective module API provided to functions at runtime.
CurrentModuleId — Class in namespace Dagger: The CurrentModuleID scalar type represents an identifier for an object of type CurrentModule.
Dagger::connect() — Method in class Dagger
EngineCacheEntry::createdTimeUnixNano() — Method in class EngineCacheEntry: The time the cache entry was created, in Unix nanoseconds.
File::contents() — Method in class File: Retrieves the contents of the file.
GeneratedCode::code() — Method in class GeneratedCode: The directory containing the generated code.
GitRef::commit() — Method in class GitRef: The resolved commit id at this ref.
GitRepository::commit() — Method in class GitRepository: Returns details of a commit.
ModuleSource::cloneRef() — Method in class ModuleSource: The ref to clone the root of the git repo from. Only valid for git sources.
ModuleSource::commit() — Method in class ModuleSource: The resolved commit of the git repo this source points to. Only valid for git sources.
ModuleSource::configExists() — Method in class ModuleSource: Whether an existing dagger.json for the module was found.
ModuleSource::contextDirectory() — Method in class ModuleSource: The full directory loaded for the module source, including the source code as a subdirectory.
ObjectTypeDef::constructor() — Method in class ObjectTypeDef: The function used to construct new instances of this object, if any
SourceMap::column() — Method in class SourceMap: The column number within the line.

D

DaggerFunction — Class in namespace Dagger\Attribute
DaggerObject — Class in namespace Dagger\Attribute
DefaultPath — Class in namespace Dagger\Attribute
Doc — Class in namespace Dagger\Attribute
Client::defaultPlatform() — Method in class Client: The default platform of the engine.
Client::directory() — Method in class Client: Creates an empty directory.
Container::defaultArgs() — Method in class Container: Retrieves default arguments for future commands.
Container::directory() — Method in class Container: Retrieves a directory at the given path.
Dagger — Class in namespace Dagger
Directory — Class in namespace Dagger: A directory.
Directory::diff() — Method in class Directory: Gets the difference between this directory and an another directory.
Directory::digest() — Method in class Directory: Return the directory's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.
Directory::directory() — Method in class Directory: Retrieves a directory at the given path.
Directory::dockerBuild() — Method in class Directory: Builds a new Docker container from this directory.
DirectoryId — Class in namespace Dagger: The DirectoryID scalar type represents an identifier for an object of type Directory.
EngineCacheEntry::description() — Method in class EngineCacheEntry: The description of the cache entry.
EngineCacheEntry::diskSpaceBytes() — Method in class EngineCacheEntry: The disk space used by the cache entry.
EngineCacheEntrySet::diskSpaceBytes() — Method in class EngineCacheEntrySet: The total disk space used by the cache entries in this set.
EnumTypeDef::description() — Method in class EnumTypeDef: A doc string for the enum, if any.
EnumValueTypeDef::description() — Method in class EnumValueTypeDef: A doc string for the enum value, if any.
FieldTypeDef::description() — Method in class FieldTypeDef: A doc string for the field, if any.
File::digest() — Method in class File: Return the file's digest. The format of the digest is not guaranteed to be stable between releases of Dagger. It is guaranteed to be stable between invocations of the same Dagger engine.
FunctionArg::defaultPath() — Method in class FunctionArg: 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
FunctionArg::defaultValue() — Method in class FunctionArg: A default value to use for this argument when not explicitly set by the caller, if any.
FunctionArg::description() — Method in class FunctionArg: A doc string for the argument, if any.
Function_::description() — Method in class Function_: A doc string for the function, if any.
Host::directory() — Method in class Host: Accesses a directory on the host.
InterfaceTypeDef::description() — Method in class InterfaceTypeDef: The doc string for the interface, if any.
Module::dependencies() — Method in class Module: The dependencies of the module.
Module::description() — Method in class Module: The doc string of the module, if any
ModuleSource::dependencies() — Method in class ModuleSource: The dependencies of the module source.
ModuleSource::digest() — Method in class ModuleSource: A content-hash of the module source. Module sources with the same digest will output the same generated context and convert into the same module instance.
ModuleSource::directory() — Method in class ModuleSource: The directory containing the module configuration and source code (source code may be in a subdir).
ObjectTypeDef::description() — Method in class ObjectTypeDef: The doc string for the object, if any.
Port::description() — Method in class Port: The port description.
ScalarTypeDef::description() — Method in class ScalarTypeDef: A doc string for the scalar, if any.

E

Client::engine() — Method in class Client: The Dagger engine container configuration and state
Client::error() — Method in class Client: Create a new error.
Container::entrypoint() — Method in class Container: Retrieves entrypoint to be prepended to the arguments of all commands.
Container::envVariable() — Method in class Container: Retrieves the value of the specified environment variable.
Container::envVariables() — Method in class Container: Retrieves the list of environment variables passed to commands.
Container::exitCode() — Method in class Container: The exit code of the last executed command.
Container::experimentalWithAllGPUs() — Method in class Container: EXPERIMENTAL API! Subject to change/removal at any time.
Container::experimentalWithGPU() — Method in class Container: EXPERIMENTAL API! Subject to change/removal at any time.
Container::export() — Method in class Container: Writes the container as an OCI tarball to the destination file path on the host.
Container::exposedPorts() — Method in class Container: Retrieves the list of exposed ports.
Directory::entries() — Method in class Directory: Returns a list of files and directories at the given path.
Directory::export() — Method in class Directory: Writes the contents of the directory to a path on the host.
Engine — Class in namespace Dagger: The Dagger engine configuration and state
EngineCache — Class in namespace Dagger: A cache storage for the Dagger engine
EngineCache::entrySet() — Method in class EngineCache: The current set of entries in the cache
EngineCacheEntry — Class in namespace Dagger: An individual cache entry in a cache entry set
EngineCacheEntryId — Class in namespace Dagger: The EngineCacheEntryID scalar type represents an identifier for an object of type EngineCacheEntry.
EngineCacheEntrySet — Class in namespace Dagger: A set of cache entries returned by a query to a cache
EngineCacheEntrySet::entries() — Method in class EngineCacheEntrySet: The list of individual cache entries in the set
EngineCacheEntrySet::entryCount() — Method in class EngineCacheEntrySet: The number of cache entries in this set.
EngineCacheEntrySetId — Class in namespace Dagger: The EngineCacheEntrySetID scalar type represents an identifier for an object of type EngineCacheEntrySet.
EngineCacheId — Class in namespace Dagger: The EngineCacheID scalar type represents an identifier for an object of type EngineCache.
EngineId — Class in namespace Dagger: The EngineID scalar type represents an identifier for an object of type Engine.
EnumTypeDef — Class in namespace Dagger: A definition of a custom enum defined in a Module.
EnumTypeDefId — Class in namespace Dagger: The EnumTypeDefID scalar type represents an identifier for an object of type EnumTypeDef.
EnumValueTypeDef — Class in namespace Dagger: A definition of a value in a custom enum defined in a Module.
EnumValueTypeDefId — Class in namespace Dagger: The EnumValueTypeDefID scalar type represents an identifier for an object of type EnumValueTypeDef.
EnvVariable — Class in namespace Dagger: An environment variable name and value.
EnvVariableId — Class in namespace Dagger: The EnvVariableID scalar type represents an identifier for an object of type EnvVariable.
Error — Class in namespace Dagger
ErrorId — Class in namespace Dagger: The ErrorID scalar type represents an identifier for an object of type Error.
File::export() — Method in class File: Writes the file to a file path on the host.
ListTypeDef::elementTypeDef() — Method in class ListTypeDef: The type of the elements in the list.
Module::enums() — Method in class Module: Enumerations served by this module.
ModuleSource::engineVersion() — Method in class ModuleSource: The engine version of the module.
Port::experimentalSkipHealthcheck() — Method in class Port: Skip the health check when run as a service.
Service::endpoint() — Method in class Service: Retrieves an endpoint that clients can use to reach this container.

F

Client::function() — Method in class Client: Creates a function.
AbstractScalar::from() — Method in class AbstractScalar
Container::file() — Method in class Container: Retrieves a file at the given path.
Container::from() — Method in class Container: Initializes this container from a pulled base image.
Directory::file() — Method in class Directory: Retrieves a file at the given path.
FieldTypeDef — Class in namespace Dagger: A definition of a field on a custom object defined in a Module.
FieldTypeDefId — Class in namespace Dagger: The FieldTypeDefID scalar type represents an identifier for an object of type FieldTypeDef.
File — Class in namespace Dagger: A file.
FileId — Class in namespace Dagger: The FileID scalar type represents an identifier for an object of type File.
FunctionArg — Class in namespace Dagger: An argument accepted by a function.
FunctionArgId — Class in namespace Dagger: The FunctionArgID scalar type represents an identifier for an object of type FunctionArg.
FunctionCall — Class in namespace Dagger: An active function call.
FunctionCallArgValue — Class in namespace Dagger: A value passed as a named argument to a function call.
FunctionCallArgValueId — Class in namespace Dagger: The FunctionCallArgValueID scalar type represents an identifier for an object of type FunctionCallArgValue.
FunctionCallId — Class in namespace Dagger: The FunctionCallID scalar type represents an identifier for an object of type FunctionCall.
FunctionId — Class in namespace Dagger: The FunctionID scalar type represents an identifier for an object of type Function.
Function_ — Class in namespace Dagger: Function represents a resolver provided by a Module.
Host::file() — Method in class Host: Accesses a file on the host.
InputTypeDef::fields() — Method in class InputTypeDef: Static fields defined on this input object, if any.
InterfaceTypeDef::functions() — Method in class InterfaceTypeDef: Functions defined on this interface, if any.
ObjectTypeDef::fields() — Method in class ObjectTypeDef: Static fields defined on this object, if any.
ObjectTypeDef::functions() — Method in class ObjectTypeDef: Functions defined on this object, if any.
SourceMap::filename() — Method in class SourceMap: The filename from the module source.

G

Client::generatedCode() — Method in class Client: Create a code generation result, given a directory containing the generated code.
Client::git() — Method in class Client: Queries a Git repository.
$ AbstractClient#graphQlClient — Property in class AbstractClient
AbstractScalar::getValue() — Method in class AbstractScalar
Connection::get() — Method in class Connection
Dagger::getClientInstance() — Method in class Dagger
Directory::glob() — Method in class Directory: Returns a list of files and directories that matche the given pattern.
GeneratedCode — Class in namespace Dagger: The result of running an SDK's codegen.
GeneratedCodeId — Class in namespace Dagger: The GeneratedCodeID scalar type represents an identifier for an object of type GeneratedCode.
GitRef — Class in namespace Dagger: A git ref (tag, branch, or commit).
GitRefId — Class in namespace Dagger: The GitRefID scalar type represents an identifier for an object of type GitRef.
GitRepository — Class in namespace Dagger: A git repository.
GitRepositoryId — Class in namespace Dagger: The GitRepositoryID scalar type represents an identifier for an object of type GitRepository.
Module::generatedContextDirectory() — Method in class Module: The generated files and directories made on top of the module source's context directory.
ModuleSource::generatedContextDirectory() — Method in class ModuleSource: The generated files and directories made on top of the module source's context directory.

H

Client::host() — Method in class Client: Queries the host environment.
Client::http() — Method in class Client: Returns a file containing an http remote url content.
GitRepository::head() — Method in class GitRepository: Returns details for HEAD.
Host — Class in namespace Dagger: Information about the host environment.
HostId — Class in namespace Dagger: The HostID scalar type represents an identifier for an object of type Host.
ModuleSource::htmlRepoURL() — Method in class ModuleSource: The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket). Only valid for git sources.
ModuleSource::htmlURL() — Method in class ModuleSource: The URL to the source's git repo in a web browser. Only valid for git sources.
Service::hostname() — Method in class Service: Retrieves a hostname which can be used by clients to reach this container.

I

Ignore — Class in namespace Dagger\Attribute
$ Ignore#ignore — Property in class Ignore
CacheVolume::id() — Method in class CacheVolume: A unique identifier for this CacheVolume.
IdAble — Class in namespace Dagger\Client
IdAble::id() — Method in class IdAble
Container::id() — Method in class Container: A unique identifier for this Container.
Container::imageRef() — Method in class Container: The unique image reference which can only be retrieved immediately after the 'Container.From' call.
Container::import() — Method in class Container: Reads the container from an OCI tarball.
CurrentModule::id() — Method in class CurrentModule: A unique identifier for this CurrentModule.
Directory::id() — Method in class Directory: A unique identifier for this Directory.
Engine::id() — Method in class Engine: A unique identifier for this Engine.
EngineCache::id() — Method in class EngineCache: A unique identifier for this EngineCache.
EngineCacheEntry::id() — Method in class EngineCacheEntry: A unique identifier for this EngineCacheEntry.
EngineCacheEntrySet::id() — Method in class EngineCacheEntrySet: A unique identifier for this EngineCacheEntrySet.
EnumTypeDef::id() — Method in class EnumTypeDef: A unique identifier for this EnumTypeDef.
EnumValueTypeDef::id() — Method in class EnumValueTypeDef: A unique identifier for this EnumValueTypeDef.
EnvVariable::id() — Method in class EnvVariable: A unique identifier for this EnvVariable.
Error::id() — Method in class Error: A unique identifier for this Error.
FieldTypeDef::id() — Method in class FieldTypeDef: A unique identifier for this FieldTypeDef.
File::id() — Method in class File: A unique identifier for this File.
FunctionArg::id() — Method in class FunctionArg: A unique identifier for this FunctionArg.
FunctionArg::ignore() — Method in class 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.
FunctionCall::id() — Method in class FunctionCall: A unique identifier for this FunctionCall.
FunctionCall::inputArgs() — Method in class FunctionCall: The argument values the function is being invoked with.
FunctionCallArgValue::id() — Method in class FunctionCallArgValue: A unique identifier for this FunctionCallArgValue.
Function_::id() — Method in class Function_: A unique identifier for this Function.
GeneratedCode::id() — Method in class GeneratedCode: A unique identifier for this GeneratedCode.
GitRef::id() — Method in class GitRef: A unique identifier for this GitRef.
GitRepository::id() — Method in class GitRepository: A unique identifier for this GitRepository.
Host::id() — Method in class Host: A unique identifier for this Host.
InputTypeDef — Class in namespace Dagger: A graphql input type, which is essentially just a group of named args.
InputTypeDef::id() — Method in class InputTypeDef: A unique identifier for this InputTypeDef.
InputTypeDefId — Class in namespace Dagger: The InputTypeDefID scalar type represents an identifier for an object of type InputTypeDef.
InterfaceTypeDef — Class in namespace Dagger: A definition of a custom interface defined in a Module.
InterfaceTypeDef::id() — Method in class InterfaceTypeDef: A unique identifier for this InterfaceTypeDef.
InterfaceTypeDefId — Class in namespace Dagger: The InterfaceTypeDefID scalar type represents an identifier for an object of type InterfaceTypeDef.
Label::id() — Method in class Label: A unique identifier for this Label.
ListTypeDef::id() — Method in class ListTypeDef: A unique identifier for this ListTypeDef.
Module::id() — Method in class Module: A unique identifier for this Module.
Module::interfaces() — Method in class Module: Interfaces served by this module.
ModuleSource::id() — Method in class ModuleSource: A unique identifier for this ModuleSource.
ObjectTypeDef::id() — Method in class ObjectTypeDef: A unique identifier for this ObjectTypeDef.
Port::id() — Method in class Port: A unique identifier for this Port.
SDKConfig::id() — Method in class SDKConfig: A unique identifier for this SDKConfig.
ScalarTypeDef::id() — Method in class ScalarTypeDef: A unique identifier for this ScalarTypeDef.
Secret::id() — Method in class Secret: A unique identifier for this Secret.
Service::id() — Method in class Service: A unique identifier for this Service.
Socket::id() — Method in class Socket: A unique identifier for this Socket.
SourceMap::id() — Method in class SourceMap: A unique identifier for this SourceMap.
Terminal::id() — Method in class Terminal: A unique identifier for this Terminal.
TypeDef::id() — Method in class TypeDef: A unique identifier for this TypeDef.

J

Json — Class in namespace Dagger: An arbitrary JSON-encoded value.

K

EngineCache::keepBytes() — Method in class EngineCache: The maximum bytes to keep in the cache without pruning, after which automatic pruning may kick in.
ModuleSource::kind() — Method in class ModuleSource: The kind of module source (currently local, git or dir).
TypeDef::kind() — Method in class TypeDef: The kind of type this is (e.g. primitive, list, object).

L

ListOfType — Class in namespace Dagger\Attribute
Client::loadCacheVolumeFromID() — Method in class Client: Load a CacheVolume from its ID.
Client::loadContainerFromID() — Method in class Client: Load a Container from its ID.
Client::loadCurrentModuleFromID() — Method in class Client: Load a CurrentModule from its ID.
Client::loadDirectoryFromID() — Method in class Client: Load a Directory from its ID.
Client::loadEngineCacheEntryFromID() — Method in class Client: Load a EngineCacheEntry from its ID.
Client::loadEngineCacheEntrySetFromID() — Method in class Client: Load a EngineCacheEntrySet from its ID.
Client::loadEngineCacheFromID() — Method in class Client: Load a EngineCache from its ID.
Client::loadEngineFromID() — Method in class Client: Load a Engine from its ID.
Client::loadEnumTypeDefFromID() — Method in class Client: Load a EnumTypeDef from its ID.
Client::loadEnumValueTypeDefFromID() — Method in class Client: Load a EnumValueTypeDef from its ID.
Client::loadEnvVariableFromID() — Method in class Client: Load a EnvVariable from its ID.
Client::loadErrorFromID() — Method in class Client: Load a Error from its ID.
Client::loadFieldTypeDefFromID() — Method in class Client: Load a FieldTypeDef from its ID.
Client::loadFileFromID() — Method in class Client: Load a File from its ID.
Client::loadFunctionArgFromID() — Method in class Client: Load a FunctionArg from its ID.
Client::loadFunctionCallArgValueFromID() — Method in class Client: Load a FunctionCallArgValue from its ID.
Client::loadFunctionCallFromID() — Method in class Client: Load a FunctionCall from its ID.
Client::loadFunctionFromID() — Method in class Client: Load a Function from its ID.
Client::loadGeneratedCodeFromID() — Method in class Client: Load a GeneratedCode from its ID.
Client::loadGitRefFromID() — Method in class Client: Load a GitRef from its ID.
Client::loadGitRepositoryFromID() — Method in class Client: Load a GitRepository from its ID.
Client::loadHostFromID() — Method in class Client: Load a Host from its ID.
Client::loadInputTypeDefFromID() — Method in class Client: Load a InputTypeDef from its ID.
Client::loadInterfaceTypeDefFromID() — Method in class Client: Load a InterfaceTypeDef from its ID.
Client::loadLabelFromID() — Method in class Client: Load a Label from its ID.
Client::loadListTypeDefFromID() — Method in class Client: Load a ListTypeDef from its ID.
Client::loadModuleFromID() — Method in class Client: Load a Module from its ID.
Client::loadModuleSourceFromID() — Method in class Client: Load a ModuleSource from its ID.
Client::loadObjectTypeDefFromID() — Method in class Client: Load a ObjectTypeDef from its ID.
Client::loadPortFromID() — Method in class Client: Load a Port from its ID.
Client::loadSDKConfigFromID() — Method in class Client: Load a SDKConfig from its ID.
Client::loadScalarTypeDefFromID() — Method in class Client: Load a ScalarTypeDef from its ID.
Client::loadSecretFromID() — Method in class Client: Load a Secret from its ID.
Client::loadSecretFromName() — Method in class Client: Load a Secret from its Name.
Client::loadServiceFromID() — Method in class Client: Load a Service from its ID.
Client::loadSocketFromID() — Method in class Client: Load a Socket from its ID.
Client::loadSourceMapFromID() — Method in class Client: Load a SourceMap from its ID.
Client::loadTerminalFromID() — Method in class Client: Load a Terminal from its ID.
Client::loadTypeDefFromID() — Method in class Client: Load a TypeDef from its ID.
$ AbstractObject#lastQuery — Property in class AbstractObject
Container::label() — Method in class Container: Retrieves the value of the specified label.
Container::labels() — Method in class Container: Retrieves the list of labels passed to container.
Engine::localCache() — Method in class Engine: The local (on-disk) cache for the Dagger engine
Label — Class in namespace Dagger: A simple key value object that represents a label.
LabelId — Class in namespace Dagger: The LabelID scalar type represents an identifier for an object of type Label.
ListTypeDef — Class in namespace Dagger: A definition of a list type in a Module.
ListTypeDefId — Class in namespace Dagger: The ListTypeDefID scalar type represents an identifier for an object of type ListTypeDef.
ModuleSource::localContextDirectoryPath() — Method in class ModuleSource: The full absolute path to the context directory on the caller's host filesystem that this module source is loaded from. Only valid for local module sources.
SourceMap::line() — Method in class SourceMap: The line number within the filename.

M

Client::module() — Method in class Client: Create a new module.
Client::moduleSource() — Method in class Client: Create a new module source instance from a source ref string
Container::mounts() — Method in class Container: Retrieves the list of paths where a directory is mounted.
EngineCache::maxUsedSpace() — Method in class EngineCache: The maximum bytes to keep in the cache without pruning.
EngineCache::minFreeSpace() — Method in class EngineCache: The target amount of free disk space the garbage collector will attempt to leave.
EngineCacheEntry::mostRecentUseTimeUnixNano() — Method in class EngineCacheEntry: The most recent time the cache entry was used, in Unix nanoseconds.
Error::message() — Method in class Error: A description of the error.
Module — Class in namespace Dagger: A Dagger module.
ModuleId — Class in namespace Dagger: The ModuleID scalar type represents an identifier for an object of type Module.
ModuleSource — Class in namespace Dagger: The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.
ModuleSource::moduleName() — Method in class ModuleSource: The name of the module, including any setting via the withName API.
ModuleSource::moduleOriginalName() — Method in class ModuleSource: The original name of the module as read from the module's dagger.json (or set for the first time with the withName API).
ModuleSourceId — Class in namespace Dagger: The ModuleSourceID scalar type represents an identifier for an object of type ModuleSource.
SourceMap::module() — Method in class SourceMap: The module dependency this was declared in.

N

Connection::newEnvSession() — Method in class Connection
Connection::newProcessSession() — Method in class Connection
CurrentModule::name() — Method in class CurrentModule: The name of the module being executed in
EnumTypeDef::name() — Method in class EnumTypeDef: The name of the enum.
EnumValueTypeDef::name() — Method in class EnumValueTypeDef: The name of the enum value.
EnvVariable::name() — Method in class EnvVariable: The environment variable name.
FieldTypeDef::name() — Method in class FieldTypeDef: The name of the field in lowerCamelCase format.
File::name() — Method in class File: Retrieves the name of the file.
FunctionArg::name() — Method in class FunctionArg: The name of the argument in lowerCamelCase format.
FunctionCall::name() — Method in class FunctionCall: The name of the function being called.
FunctionCallArgValue::name() — Method in class FunctionCallArgValue: The name of the argument.
Function_::name() — Method in class Function_: The name of the function.
InputTypeDef::name() — Method in class InputTypeDef: The name of the input object.
InterfaceTypeDef::name() — Method in class InterfaceTypeDef: The name of the interface.
Label::name() — Method in class Label: The label name.
Module::name() — Method in class Module: The name of the module
ObjectTypeDef::name() — Method in class ObjectTypeDef: The name of the object.
ScalarTypeDef::name() — Method in class ScalarTypeDef: The name of the scalar.
Secret::name() — Method in class Secret: The name of this secret.

O

Module::objects() — Method in class Module: Objects served by this module.
ObjectTypeDef — Class in namespace Dagger: A definition of a custom object defined in a Module.
ObjectTypeDefId — Class in namespace Dagger: The ObjectTypeDefID scalar type represents an identifier for an object of type ObjectTypeDef.
TypeDef::optional() — Method in class TypeDef: Whether this type can be set to null. Defaults to false.

P

Container::platform() — Method in class Container: The platform this container executes and publishes as.
Container::publish() — Method in class Container: Publishes this container as a new image to the specified address.
EngineCache::prune() — Method in class EngineCache: Prune the cache of releaseable entries
FunctionCall::parent() — Method in class FunctionCall: The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.
FunctionCall::parentName() — Method in class FunctionCall: The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.
ModuleSource::pin() — Method in class ModuleSource: The pinned version of this module source.
PipelineLabel — Class in namespace Dagger: Key value object that represents a pipeline label.
Platform — Class in namespace Dagger: The platform config OS and architecture in a Container.
Port — Class in namespace Dagger: A port exposed by a container.
Port::port() — Method in class Port: The port number.
Port::protocol() — Method in class Port: The transport layer protocol.
PortForward — Class in namespace Dagger: Port forwarding rules for tunneling network traffic.
PortId — Class in namespace Dagger: The PortID scalar type represents an identifier for an object of type Port.
Secret::plaintext() — Method in class Secret: The value of this secret.
Service::ports() — Method in class Service: Retrieves the list of ports provided by the service.

Q

AbstractClient::queryLeaf() — Method in class AbstractClient
AbstractObject::queryLeaf() — Method in class AbstractObject
QueryBuilder — Class in namespace Dagger\Client

R

ReturnsListOfType — Class in namespace Dagger\Attribute
AbstractClient::runQuery() — Method in class AbstractClient
Container::rootfs() — Method in class Container: Retrieves this container's root filesystem. Mounts are not included.
EngineCache::reservedSpace() — Method in class EngineCache
FunctionCall::returnError() — Method in class FunctionCall: Return an error from the function.
FunctionCall::returnValue() — Method in class FunctionCall: Set the return value of the function call to the provided value.
Function_::returnType() — Method in class Function_: The type returned by the function.
GitRepository::ref() — Method in class GitRepository: Returns details of a ref.
Module::runtime() — Method in class Module: The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.
ModuleSource::repoRootPath() — Method in class ModuleSource: The import path corresponding to the root of the git repo this source points to. Only valid for git sources.

S

Client::secret() — Method in class Client: Creates a new secret.
Client::setSecret() — Method in class Client: Sets a secret given a user defined name to its plaintext and returns the secret.
Client::sourceMap() — Method in class Client: Creates source map metadata.
QueryBuilder::setArgument() — Method in class QueryBuilder
Container::stderr() — Method in class Container: The error stream of the last executed command.
Container::stdout() — Method in class Container: The output stream of the last executed command.
Container::sync() — Method in class Container: Forces evaluation of the pipeline in the engine.
CurrentModule::source() — Method in class CurrentModule: The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).
Directory::sync() — Method in class Directory: Force evaluation in the engine.
EnumTypeDef::sourceMap() — Method in class EnumTypeDef: The location of this enum declaration.
EnumTypeDef::sourceModuleName() — Method in class EnumTypeDef: If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.
EnumValueTypeDef::sourceMap() — Method in class EnumValueTypeDef: The location of this enum value declaration.
FieldTypeDef::sourceMap() — Method in class FieldTypeDef: The location of this field declaration.
File::size() — Method in class File: Retrieves the size of the file, in bytes.
File::sync() — Method in class File: Force evaluation in the engine.
FunctionArg::sourceMap() — Method in class FunctionArg: The location of this arg declaration.
Function_::sourceMap() — Method in class Function_: The location of this function declaration.
Host::service() — Method in class Host: Creates a service that forwards traffic to a specified address via the host.
Host::setSecretFile() — Method in class Host: Sets a secret given a user-defined name and the file path on the host, and returns the secret.
InterfaceTypeDef::sourceMap() — Method in class InterfaceTypeDef: The location of this interface declaration.
InterfaceTypeDef::sourceModuleName() — Method in class InterfaceTypeDef: If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.
Module::sdk() — Method in class Module: The SDK config used by this module.
Module::serve() — Method in class Module: Serve a module's API in the current session.
Module::source() — Method in class Module: The source for the module.
Module::sync() — Method in class Module: Forces evaluation of the module, including any loading into the engine and associated validation.
ModuleSource::sdk() — Method in class ModuleSource: The SDK configuration of the module.
ModuleSource::sourceRootSubpath() — Method in class ModuleSource: The path, relative to the context directory, that contains the module's dagger.json.
ModuleSource::sourceSubpath() — Method in class ModuleSource: The path to the directory containing the module's source code, relative to the context directory.
ModuleSource::sync() — Method in class ModuleSource: Forces evaluation of the module source, including any loading into the engine and associated validation.
ObjectTypeDef::sourceMap() — Method in class ObjectTypeDef: The location of this object declaration.
ObjectTypeDef::sourceModuleName() — Method in class ObjectTypeDef: If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.
SDKConfig — Class in namespace Dagger: The SDK config of the module.
SDKConfig::source() — Method in class SDKConfig: Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.
SDKConfigId — Class in namespace Dagger: The SDKConfigID scalar type represents an identifier for an object of type SDKConfig.
ScalarTypeDef — Class in namespace Dagger: A definition of a custom scalar defined in a Module.
ScalarTypeDef::sourceModuleName() — Method in class ScalarTypeDef: If this ScalarTypeDef is associated with a Module, the name of the module. Unset otherwise.
ScalarTypeDefId — Class in namespace Dagger: The ScalarTypeDefID scalar type represents an identifier for an object of type ScalarTypeDef.
Secret — Class in namespace Dagger: A reference to a secret value, which can be handled more safely than the value itself.
SecretId — Class in namespace Dagger: The SecretID scalar type represents an identifier for an object of type Secret.
Service — Class in namespace Dagger: A content-addressed service providing TCP connectivity.
Service::start() — Method in class Service: Start the service and wait for its health checks to succeed.
Service::stop() — Method in class Service: Stop the service.
ServiceId — Class in namespace Dagger: The ServiceID scalar type represents an identifier for an object of type Service.
Socket — Class in namespace Dagger: A Unix or TCP/IP socket that can be mounted into a container.
SocketId — Class in namespace Dagger: The SocketID scalar type represents an identifier for an object of type Socket.
SourceMap — Class in namespace Dagger: Source location information.
SourceMapId — Class in namespace Dagger: The SourceMapID scalar type represents an identifier for an object of type SourceMap.
Terminal::sync() — Method in class Terminal: Forces evaluation of the pipeline in the engine.

T

Client::typeDef() — Method in class Client: Create a new TypeDef.
Container::terminal() — Method in class Container: Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).
Directory::terminal() — Method in class Directory: Opens an interactive terminal in new container with this directory mounted inside.
FieldTypeDef::typeDef() — Method in class FieldTypeDef: The type of the field.
FunctionArg::typeDef() — Method in class FunctionArg: The type of the argument.
GitRef::tree() — Method in class GitRef: The filesystem tree at this ref.
GitRepository::tag() — Method in class GitRepository: Returns details of a tag.
GitRepository::tags() — Method in class GitRepository: tags that match any of the given glob patterns.
Host::tunnel() — Method in class Host: Creates a tunnel that forwards traffic from the host to a service.
Terminal — Class in namespace Dagger: An interactive terminal that clients can connect to.
TerminalId — Class in namespace Dagger: The TerminalID scalar type represents an identifier for an object of type Terminal.
TypeDef — Class in namespace Dagger: A definition of a parameter or return type in a Module.
TypeDefId — Class in namespace Dagger: The TypeDefID scalar type represents an identifier for an object of type TypeDef.

U

Container::up() — Method in class Container: Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service.
Container::user() — Method in class Container: Retrieves the user to be set for all commands.
Host::unixSocket() — Method in class Host: Accesses a Unix socket on the host.
Secret::uri() — Method in class Secret: The URI of this secret.
Service::up() — Method in class Service: Creates a tunnel that forwards traffic from the caller's network to this service.

V

Client::version() — Method in class Client: Get the current Dagger Engine version.
EnumTypeDef::values() — Method in class EnumTypeDef: The values of the enum.
EnvVariable::value() — Method in class EnvVariable: The environment variable value.
FunctionCallArgValue::value() — Method in class FunctionCallArgValue: The value of the argument represented as a JSON serialized string.
GeneratedCode::vcsGeneratedPaths() — Method in class GeneratedCode: List of paths to mark generated in version control (i.e. .gitattributes).
GeneratedCode::vcsIgnoredPaths() — Method in class GeneratedCode: List of paths to ignore in version control (i.e. .gitignore).
Label::value() — Method in class Label: The label value.
ModuleSource::version() — Method in class ModuleSource: The specified version of the git repo this source points to. Only valid for git sources.

W

Container::withAnnotation() — Method in class Container: Retrieves this container plus the given OCI anotation.
Container::withDefaultArgs() — Method in class Container: Configures default arguments for future commands.
Container::withDefaultTerminalCmd() — Method in class Container: Set the default command to invoke for the container's terminal API.
Container::withDirectory() — Method in class Container: Retrieves this container plus a directory written at the given path.
Container::withEntrypoint() — Method in class Container: Retrieves this container but with a different command entrypoint.
Container::withEnvVariable() — Method in class Container: Retrieves this container plus the given environment variable.
Container::withExec() — Method in class Container: Retrieves this container after executing the specified command inside it.
Container::withExposedPort() — Method in class Container: Expose a network port.
Container::withFile() — Method in class Container: Retrieves this container plus the contents of the given file copied to the given path.
Container::withFiles() — Method in class Container: Retrieves this container plus the contents of the given files copied to the given path.
Container::withLabel() — Method in class Container: Retrieves this container plus the given label.
Container::withMountedCache() — Method in class Container: Retrieves this container plus a cache volume mounted at the given path.
Container::withMountedDirectory() — Method in class Container: Retrieves this container plus a directory mounted at the given path.
Container::withMountedFile() — Method in class Container: Retrieves this container plus a file mounted at the given path.
Container::withMountedSecret() — Method in class Container: Retrieves this container plus a secret mounted into a file at the given path.
Container::withMountedTemp() — Method in class Container: Retrieves this container plus a temporary directory mounted at the given path. Any writes will be ephemeral to a single withExec call; they will not be persisted to subsequent withExecs.
Container::withNewFile() — Method in class Container: Retrieves this container plus a new file written at the given path.
Container::withRegistryAuth() — Method in class Container: Retrieves this container with a registry authentication for a given address.
Container::withRootfs() — Method in class Container: Retrieves the container with the given directory mounted to /.
Container::withSecretVariable() — Method in class Container: Retrieves this container plus an env variable containing the given secret.
Container::withServiceBinding() — Method in class Container: Establish a runtime dependency on a service.
Container::withUnixSocket() — Method in class Container: Retrieves this container plus a socket forwarded to the given Unix socket path.
Container::withUser() — Method in class Container: Retrieves this container with a different command user.
Container::withWorkdir() — Method in class Container: Retrieves this container with a different working directory.
Container::withoutAnnotation() — Method in class Container: Retrieves this container minus the given OCI annotation.
Container::withoutDefaultArgs() — Method in class Container: Retrieves this container with unset default arguments for future commands.
Container::withoutDirectory() — Method in class Container: Retrieves this container with the directory at the given path removed.
Container::withoutEntrypoint() — Method in class Container: Retrieves this container with an unset command entrypoint.
Container::withoutEnvVariable() — Method in class Container: Retrieves this container minus the given environment variable.
Container::withoutExposedPort() — Method in class Container: Unexpose a previously exposed port.
Container::withoutFile() — Method in class Container: Retrieves this container with the file at the given path removed.
Container::withoutFiles() — Method in class Container: Retrieves this container with the files at the given paths removed.
Container::withoutLabel() — Method in class Container: Retrieves this container minus the given environment label.
Container::withoutMount() — Method in class Container: Retrieves this container after unmounting everything at the given path.
Container::withoutRegistryAuth() — Method in class Container: Retrieves this container without the registry authentication of a given address.
Container::withoutSecretVariable() — Method in class Container: Retrieves this container minus the given environment variable containing the secret.
Container::withoutUnixSocket() — Method in class Container: Retrieves this container with a previously added Unix socket removed.
Container::withoutUser() — Method in class Container: Retrieves this container with an unset command user.
Container::withoutWorkdir() — Method in class Container: Retrieves this container with an unset working directory.
Container::workdir() — Method in class Container: Retrieves the working directory for all commands.
CurrentModule::workdir() — Method in class CurrentModule: Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.
CurrentModule::workdirFile() — Method in class CurrentModule: Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.Load a file from the module's scratch working directory, including any changes that may have been made to it during module function execution.
Directory::withDirectory() — Method in class Directory: Retrieves this directory plus a directory written at the given path.
Directory::withFile() — Method in class Directory: Retrieves this directory plus the contents of the given file copied to the given path.
Directory::withFiles() — Method in class Directory: Retrieves this directory plus the contents of the given files copied to the given path.
Directory::withNewDirectory() — Method in class Directory: Retrieves this directory plus a new directory created at the given path.
Directory::withNewFile() — Method in class Directory: Retrieves this directory plus a new file written at the given path.
Directory::withTimestamps() — Method in class Directory: Retrieves this directory with all file/dir timestamps set to the given time.
Directory::withoutDirectory() — Method in class Directory: Retrieves this directory with the directory at the given path removed.
Directory::withoutFile() — Method in class Directory: Retrieves this directory with the file at the given path removed.
Directory::withoutFiles() — Method in class Directory: Retrieves this directory with the files at the given paths removed.
File::withName() — Method in class File: Retrieves this file with its name set to the given name.
File::withTimestamps() — Method in class File: Retrieves this file with its created/modified timestamps set to the given time.
Function_::withArg() — Method in class Function_: Returns the function with the provided argument
Function_::withDescription() — Method in class Function_: Returns the function with the given doc string.
Function_::withSourceMap() — Method in class Function_: Returns the function with the given source map.
GeneratedCode::withVCSGeneratedPaths() — Method in class GeneratedCode: Set the list of paths to mark generated in version control.
GeneratedCode::withVCSIgnoredPaths() — Method in class GeneratedCode: Set the list of paths to ignore in version control.
GitRepository::withAuthHeader() — Method in class GitRepository: Header to authenticate the remote with.
GitRepository::withAuthToken() — Method in class GitRepository: Token to authenticate the remote with.
Module::withDescription() — Method in class Module: Retrieves the module with the given description
Module::withEnum() — Method in class Module: This module plus the given Enum type and associated values
Module::withInterface() — Method in class Module: This module plus the given Interface type and associated functions
Module::withObject() — Method in class Module: This module plus the given Object type and associated functions.
ModuleSource::withDependencies() — Method in class ModuleSource: Append the provided dependencies to the module source's dependency list.
ModuleSource::withEngineVersion() — Method in class ModuleSource: Upgrade the engine version of the module to the given value.
ModuleSource::withIncludes() — Method in class ModuleSource: Update the module source with additional include patterns for files+directories from its context that are required for building it
ModuleSource::withName() — Method in class ModuleSource: Update the module source with a new name.
ModuleSource::withSDK() — Method in class ModuleSource: Update the module source with a new SDK.
ModuleSource::withSourceSubpath() — Method in class ModuleSource: Update the module source with a new source subpath.
ModuleSource::withUpdateDependencies() — Method in class ModuleSource: Update one or more module dependencies.
ModuleSource::withoutDependencies() — Method in class ModuleSource: Remove the provided dependencies from the module source's dependency list.
Service::withHostname() — Method in class Service: Configures a hostname which can be used by clients within the session to reach this container.
TypeDef::withConstructor() — Method in class TypeDef: Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.
TypeDef::withEnum() — Method in class TypeDef: Returns a TypeDef of kind Enum with the provided name.
TypeDef::withEnumValue() — Method in class TypeDef: Adds a static value for an Enum TypeDef, failing if the type is not an enum.
TypeDef::withField() — Method in class TypeDef: Adds a static field for an Object TypeDef, failing if the type is not an object.
TypeDef::withFunction() — Method in class TypeDef: Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds.
TypeDef::withInterface() — Method in class TypeDef: Returns a TypeDef of kind Interface with the provided name.
TypeDef::withKind() — Method in class TypeDef: Sets the kind of the type.
TypeDef::withListOf() — Method in class TypeDef: Returns a TypeDef of kind List with the provided type for its elements.
TypeDef::withObject() — Method in class TypeDef: Returns a TypeDef of kind Object with the provided name.
TypeDef::withOptional() — Method in class TypeDef: Sets whether this type can be set to null.
TypeDef::withScalar() — Method in class TypeDef: Returns a TypeDef of kind Scalar with the provided name.

_

Argument::__construct() — Method in class Argument
DaggerFunction::__construct() — Method in class DaggerFunction
DefaultPath::__construct() — Method in class DefaultPath
Doc::__construct() — Method in class Doc
Ignore::__construct() — Method in class Ignore
ListOfType::__construct() — Method in class ListOfType
ReturnsListOfType::__construct() — Method in class ReturnsListOfType
BuildArg::__construct() — Method in class BuildArg
AbstractClient::__construct() — Method in class AbstractClient
AbstractInputObject::__toString() — Method in class AbstractInputObject
AbstractObject::__construct() — Method in class AbstractObject
AbstractScalar::__construct() — Method in class AbstractScalar
AbstractScalar::__toString() — Method in class AbstractScalar
PipelineLabel::__construct() — Method in class PipelineLabel
PortForward::__construct() — Method in class PortForward