Client
class Client extends AbstractClient
The root of the DAG.
Properties
protected AbstractClient | $client | from AbstractClient | |
protected Client | $graphQlClient | from AbstractClient |
Methods
No description
No description
Constructs a cache volume for a given cache key.
Creates a scratch container, with no image or metadata.
The FunctionCall context that the SDK caller is currently executing in.
The module currently being served in the session, if any.
The TypeDef representations of the objects currently being served in the session.
The default platform of the engine.
Create a code generation result, given a directory containing the generated code.
Queries a Git repository.
Returns a file containing an http remote url content.
Initialize a Large Language Model (LLM)
Load a Binding from its ID.
Load a CacheVolume from its ID.
Load a Container from its ID.
Load a CurrentModule from its ID.
Load a Directory from its ID.
Load a EngineCacheEntry from its ID.
Load a EngineCacheEntrySet from its ID.
Load a EngineCache from its ID.
Load a Engine from its ID.
Load a EnumTypeDef from its ID.
Load a EnumValueTypeDef from its ID.
Load a Env from its ID.
Load a EnvVariable from its ID.
Load a Error from its ID.
Load a ErrorValue from its ID.
Load a FieldTypeDef from its ID.
Load a File from its ID.
Load a FunctionArg from its ID.
Load a FunctionCallArgValue from its ID.
Load a FunctionCall from its ID.
Load a Function from its ID.
Load a GeneratedCode from its ID.
Load a GitRef from its ID.
Load a GitRepository from its ID.
Load a Host from its ID.
Load a InputTypeDef from its ID.
Load a InterfaceTypeDef from its ID.
Load a LLM from its ID.
Load a LLMTokenUsage from its ID.
Load a Label from its ID.
Load a ListTypeDef from its ID.
Load a ModuleConfigClient from its ID.
Load a Module from its ID.
Load a ModuleSource from its ID.
Load a ObjectTypeDef from its ID.
Load a Port from its ID.
Load a SDKConfig from its ID.
Load a ScalarTypeDef from its ID.
Load a Secret from its ID.
Load a Service from its ID.
Load a Socket from its ID.
Load a SourceMap from its ID.
Load a Terminal from its ID.
Load a TypeDef from its ID.
Create a new module source instance from a source ref string
Sets a secret given a user defined name to its plaintext and returns the secret.
Get the current Dagger Engine version.
Details
in
AbstractClient at line 20
__construct(Client $clientOrConnection, QueryBuilderChain $queryBuilderChain = new QueryBuilderChain())
No description
in
AbstractClient at line 33
Results
runQuery(Query $query)
No description
in
AbstractClient at line 38
null|array|string|int|float|bool
queryLeaf(Query $query, string $leafKey)
No description
at line 19
CacheVolume
cacheVolume(string $key, string|null $namespace = '')
Constructs a cache volume for a given cache key.
at line 34
Container
container(Platform|null $platform = null)
Creates a scratch container, with no image or metadata.
To pull an image, follow up with the "from" function.
at line 48
FunctionCall
currentFunctionCall()
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.
at line 57
CurrentModule
currentModule()
The module currently being served in the session, if any.
at line 66
array
currentTypeDefs()
The TypeDef representations of the objects currently being served in the session.
at line 75
Platform
defaultPlatform()
The default platform of the engine.
at line 84
Directory
directory()
Creates an empty directory.
at line 93
Engine
engine()
The Dagger engine container configuration and state
at line 102
Env
env(bool|null $privileged = false, bool|null $writable = false)
Initialize a new environment
at line 117
Error
error(string $message)
Create a new error.
at line 127
Function_
function(string $name, TypeDef $returnType)
Creates a function.
at line 138
GeneratedCode
generatedCode(Directory $code)
Create a code generation result, given a directory containing the generated code.
at line 148
GitRepository
git(string $url, bool|null $keepGitDir = true, Service|null $experimentalServiceHost = null, string|null $sshKnownHosts = '', Socket|null $sshAuthSocket = null)
Queries a Git repository.
at line 175
Host
host()
Queries the host environment.
at line 184
File
http(string $url, Service|null $experimentalServiceHost = null)
Returns a file containing an http remote url content.
at line 197
LLM
llm(string|null $model = null, int|null $maxAPICalls = null)
Initialize a Large Language Model (LLM)
at line 212
Binding
loadBindingFromID(Binding $id)
Load a Binding from its ID.
at line 222
CacheVolume
loadCacheVolumeFromID(CacheVolume $id)
Load a CacheVolume from its ID.
at line 232
Container
loadContainerFromID(Container $id)
Load a Container from its ID.
at line 242
CurrentModule
loadCurrentModuleFromID(CurrentModule $id)
Load a CurrentModule from its ID.
at line 252
Directory
loadDirectoryFromID(Directory $id)
Load a Directory from its ID.
at line 262
EngineCacheEntry
loadEngineCacheEntryFromID(EngineCacheEntry $id)
Load a EngineCacheEntry from its ID.
at line 272
EngineCacheEntrySet
loadEngineCacheEntrySetFromID(EngineCacheEntrySet $id)
Load a EngineCacheEntrySet from its ID.
at line 282
EngineCache
loadEngineCacheFromID(EngineCache $id)
Load a EngineCache from its ID.
at line 292
Engine
loadEngineFromID(Engine $id)
Load a Engine from its ID.
at line 302
EnumTypeDef
loadEnumTypeDefFromID(EnumTypeDef $id)
Load a EnumTypeDef from its ID.
at line 312
EnumValueTypeDef
loadEnumValueTypeDefFromID(EnumValueTypeDef $id)
Load a EnumValueTypeDef from its ID.
at line 322
Env
loadEnvFromID(Env $id)
Load a Env from its ID.
at line 332
EnvVariable
loadEnvVariableFromID(EnvVariable $id)
Load a EnvVariable from its ID.
at line 342
Error
loadErrorFromID(Error $id)
Load a Error from its ID.
at line 352
ErrorValue
loadErrorValueFromID(ErrorValue $id)
Load a ErrorValue from its ID.
at line 362
FieldTypeDef
loadFieldTypeDefFromID(FieldTypeDef $id)
Load a FieldTypeDef from its ID.
at line 372
File
loadFileFromID(File $id)
Load a File from its ID.
at line 382
FunctionArg
loadFunctionArgFromID(FunctionArg $id)
Load a FunctionArg from its ID.
at line 392
FunctionCallArgValue
loadFunctionCallArgValueFromID(FunctionCallArgValue $id)
Load a FunctionCallArgValue from its ID.
at line 403
FunctionCall
loadFunctionCallFromID(FunctionCall $id)
Load a FunctionCall from its ID.
at line 413
Function_
loadFunctionFromID(Function_ $id)
Load a Function from its ID.
at line 423
GeneratedCode
loadGeneratedCodeFromID(GeneratedCode $id)
Load a GeneratedCode from its ID.
at line 433
GitRef
loadGitRefFromID(GitRef $id)
Load a GitRef from its ID.
at line 443
GitRepository
loadGitRepositoryFromID(GitRepository $id)
Load a GitRepository from its ID.
at line 453
Host
loadHostFromID(Host $id)
Load a Host from its ID.
at line 463
InputTypeDef
loadInputTypeDefFromID(InputTypeDef $id)
Load a InputTypeDef from its ID.
at line 473
InterfaceTypeDef
loadInterfaceTypeDefFromID(InterfaceTypeDef $id)
Load a InterfaceTypeDef from its ID.
at line 483
LLM
loadLLMFromID(LLM $id)
Load a LLM from its ID.
at line 493
LLMTokenUsage
loadLLMTokenUsageFromID(LLMTokenUsage $id)
Load a LLMTokenUsage from its ID.
at line 503
Label
loadLabelFromID(Label $id)
Load a Label from its ID.
at line 513
ListTypeDef
loadListTypeDefFromID(ListTypeDef $id)
Load a ListTypeDef from its ID.
at line 523
ModuleConfigClient
loadModuleConfigClientFromID(ModuleConfigClient $id)
Load a ModuleConfigClient from its ID.
at line 533
Module
loadModuleFromID(Module $id)
Load a Module from its ID.
at line 543
ModuleSource
loadModuleSourceFromID(ModuleSource $id)
Load a ModuleSource from its ID.
at line 553
ObjectTypeDef
loadObjectTypeDefFromID(ObjectTypeDef $id)
Load a ObjectTypeDef from its ID.
at line 563
Port
loadPortFromID(Port $id)
Load a Port from its ID.
at line 573
SDKConfig
loadSDKConfigFromID(SDKConfig $id)
Load a SDKConfig from its ID.
at line 583
ScalarTypeDef
loadScalarTypeDefFromID(ScalarTypeDef $id)
Load a ScalarTypeDef from its ID.
at line 593
Secret
loadSecretFromID(Secret $id)
Load a Secret from its ID.
at line 603
Service
loadServiceFromID(Service $id)
Load a Service from its ID.
at line 613
Socket
loadSocketFromID(Socket $id)
Load a Socket from its ID.
at line 623
SourceMap
loadSourceMapFromID(SourceMap $id)
Load a SourceMap from its ID.
at line 633
Terminal
loadTerminalFromID(Terminal $id)
Load a Terminal from its ID.
at line 643
TypeDef
loadTypeDefFromID(TypeDef $id)
Load a TypeDef from its ID.
at line 653
Module
module()
Create a new module.
at line 662
ModuleSource
moduleSource(string $refString, string|null $refPin = '', bool|null $disableFindUp = false, bool|null $allowNotExists = false, ModuleSourceKind|null $requireKind = null)
Create a new module source instance from a source ref string
at line 689
Secret
secret(string $uri)
Creates a new secret.
at line 701
Secret
setSecret(string $name, string $plaintext)
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.
at line 712
SourceMap
sourceMap(string $filename, int $line, int $column)
Creates source map metadata.
at line 724
TypeDef
typeDef()
Create a new TypeDef.
at line 733
string
version()
Get the current Dagger Engine version.