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
Retrieves a container builtin to the engine.
Constructs a cache volume for a given cache key.
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 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 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 LLMVariable 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 PhpSdk 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 Secret from its Name.
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
Container
_builtinContainer(string $digest)
Retrieves a container builtin to the engine.
at line 29
CacheVolume
cacheVolume(string $key, string|null $namespace = '')
Constructs a cache volume for a given cache key.
at line 44
Container
container(Platform|null $platform = null)
Creates a scratch container.
Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder's host.
at line 58
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 67
CurrentModule
currentModule()
The module currently being served in the session, if any.
at line 76
array
currentTypeDefs()
The TypeDef representations of the objects currently being served in the session.
at line 85
Platform
defaultPlatform()
The default platform of the engine.
at line 94
Directory
directory()
Creates an empty directory.
at line 103
Engine
engine()
The Dagger engine container configuration and state
at line 112
Error
error(string $message)
Create a new error.
at line 122
Function_
function(string $name, TypeDef $returnType)
Creates a function.
at line 133
GeneratedCode
generatedCode(Directory $code)
Create a code generation result, given a directory containing the generated code.
at line 143
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 170
Host
host()
Queries the host environment.
at line 179
File
http(string $url, Service|null $experimentalServiceHost = null)
Returns a file containing an http remote url content.
at line 192
LLM
llm(string|null $model = null, int|null $maxAPICalls = null)
Initialize a Large Language Model (LLM)
at line 207
CacheVolume
loadCacheVolumeFromID(CacheVolume $id)
Load a CacheVolume from its ID.
at line 217
Container
loadContainerFromID(Container $id)
Load a Container from its ID.
at line 227
CurrentModule
loadCurrentModuleFromID(CurrentModule $id)
Load a CurrentModule from its ID.
at line 237
Directory
loadDirectoryFromID(Directory $id)
Load a Directory from its ID.
at line 247
EngineCacheEntry
loadEngineCacheEntryFromID(EngineCacheEntry $id)
Load a EngineCacheEntry from its ID.
at line 257
EngineCacheEntrySet
loadEngineCacheEntrySetFromID(EngineCacheEntrySet $id)
Load a EngineCacheEntrySet from its ID.
at line 267
EngineCache
loadEngineCacheFromID(EngineCache $id)
Load a EngineCache from its ID.
at line 277
Engine
loadEngineFromID(Engine $id)
Load a Engine from its ID.
at line 287
EnumTypeDef
loadEnumTypeDefFromID(EnumTypeDef $id)
Load a EnumTypeDef from its ID.
at line 297
EnumValueTypeDef
loadEnumValueTypeDefFromID(EnumValueTypeDef $id)
Load a EnumValueTypeDef from its ID.
at line 307
EnvVariable
loadEnvVariableFromID(EnvVariable $id)
Load a EnvVariable from its ID.
at line 317
Error
loadErrorFromID(Error $id)
Load a Error from its ID.
at line 327
ErrorValue
loadErrorValueFromID(ErrorValue $id)
Load a ErrorValue from its ID.
at line 337
FieldTypeDef
loadFieldTypeDefFromID(FieldTypeDef $id)
Load a FieldTypeDef from its ID.
at line 347
File
loadFileFromID(File $id)
Load a File from its ID.
at line 357
FunctionArg
loadFunctionArgFromID(FunctionArg $id)
Load a FunctionArg from its ID.
at line 367
FunctionCallArgValue
loadFunctionCallArgValueFromID(FunctionCallArgValue $id)
Load a FunctionCallArgValue from its ID.
at line 378
FunctionCall
loadFunctionCallFromID(FunctionCall $id)
Load a FunctionCall from its ID.
at line 388
Function_
loadFunctionFromID(Function_ $id)
Load a Function from its ID.
at line 398
GeneratedCode
loadGeneratedCodeFromID(GeneratedCode $id)
Load a GeneratedCode from its ID.
at line 408
GitRef
loadGitRefFromID(GitRef $id)
Load a GitRef from its ID.
at line 418
GitRepository
loadGitRepositoryFromID(GitRepository $id)
Load a GitRepository from its ID.
at line 428
Host
loadHostFromID(Host $id)
Load a Host from its ID.
at line 438
InputTypeDef
loadInputTypeDefFromID(InputTypeDef $id)
Load a InputTypeDef from its ID.
at line 448
InterfaceTypeDef
loadInterfaceTypeDefFromID(InterfaceTypeDef $id)
Load a InterfaceTypeDef from its ID.
at line 458
LLM
loadLLMFromID(LLM $id)
Load a LLM from its ID.
at line 468
LLMVariable
loadLLMVariableFromID(LLMVariable $id)
Load a LLMVariable from its ID.
at line 478
Label
loadLabelFromID(Label $id)
Load a Label from its ID.
at line 488
ListTypeDef
loadListTypeDefFromID(ListTypeDef $id)
Load a ListTypeDef from its ID.
at line 498
ModuleConfigClient
loadModuleConfigClientFromID(ModuleConfigClient $id)
Load a ModuleConfigClient from its ID.
at line 508
Module
loadModuleFromID(Module $id)
Load a Module from its ID.
at line 518
ModuleSource
loadModuleSourceFromID(ModuleSource $id)
Load a ModuleSource from its ID.
at line 528
ObjectTypeDef
loadObjectTypeDefFromID(ObjectTypeDef $id)
Load a ObjectTypeDef from its ID.
at line 538
PhpSdk
loadPhpSdkFromID(PhpSdk $id)
Load a PhpSdk from its ID.
at line 548
Port
loadPortFromID(Port $id)
Load a Port from its ID.
at line 558
SDKConfig
loadSDKConfigFromID(SDKConfig $id)
Load a SDKConfig from its ID.
at line 568
ScalarTypeDef
loadScalarTypeDefFromID(ScalarTypeDef $id)
Load a ScalarTypeDef from its ID.
at line 578
Secret
loadSecretFromID(Secret $id)
Load a Secret from its ID.
at line 588
Secret
loadSecretFromName(string $name, string|null $accessor = null)
Load a Secret from its Name.
at line 601
Service
loadServiceFromID(Service $id)
Load a Service from its ID.
at line 611
Socket
loadSocketFromID(Socket $id)
Load a Socket from its ID.
at line 621
SourceMap
loadSourceMapFromID(SourceMap $id)
Load a SourceMap from its ID.
at line 631
Terminal
loadTerminalFromID(Terminal $id)
Load a Terminal from its ID.
at line 641
TypeDef
loadTypeDefFromID(TypeDef $id)
Load a TypeDef from its ID.
at line 651
Module
module()
Create a new module.
at line 660
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 684
PhpSdk
phpSdk(Directory|null $sdkSourceDir = null)
No description
at line 696
Secret
secret(string $uri)
Creates a new secret.
at line 708
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 719
SourceMap
sourceMap(string $filename, int $line, int $column)
Creates source map metadata.
at line 731
TypeDef
typeDef()
Create a new TypeDef.
at line 740
string
version()
Get the current Dagger Engine version.