Documentation ¶
Index ¶
- func Blob(digest string, size int, mediaType string, uncompressed string) *dagger.Directory
- func BuiltinContainer(digest string) *dagger.Container
- func CacheVolume(key string) *dagger.CacheVolume
- func CheckVersionCompatibility(ctx context.Context, version string) (bool, error)
- func Close() error
- func Container(opts ...dagger.ContainerOpts) *dagger.Container
- func CurrentFunctionCall() *dagger.FunctionCall
- func CurrentModule() *dagger.CurrentModule
- func CurrentTypeDefs(ctx context.Context) ([]dagger.TypeDef, error)
- func DefaultPlatform(ctx context.Context) (dagger.Platform, error)
- func Directory(opts ...dagger.DirectoryOpts) *dagger.Directory
- func File(id dagger.FileID) *dagger.Filedeprecated
- func Function(name string, returnType *dagger.TypeDef) *dagger.Function
- func GeneratedCode(code *dagger.Directory) *dagger.GeneratedCode
- func Git(url string, opts ...dagger.GitOpts) *dagger.GitRepository
- func HTTP(url string, opts ...dagger.HTTPOpts) *dagger.File
- func Host() *dagger.Host
- func LoadCacheVolumeFromID(id dagger.CacheVolumeID) *dagger.CacheVolume
- func LoadContainerFromID(id dagger.ContainerID) *dagger.Container
- func LoadCurrentModuleFromID(id dagger.CurrentModuleID) *dagger.CurrentModule
- func LoadDirectoryFromID(id dagger.DirectoryID) *dagger.Directory
- func LoadEnvVariableFromID(id dagger.EnvVariableID) *dagger.EnvVariable
- func LoadFieldTypeDefFromID(id dagger.FieldTypeDefID) *dagger.FieldTypeDef
- func LoadFileFromID(id dagger.FileID) *dagger.File
- func LoadFunctionArgFromID(id dagger.FunctionArgID) *dagger.FunctionArg
- func LoadFunctionCallArgValueFromID(id dagger.FunctionCallArgValueID) *dagger.FunctionCallArgValue
- func LoadFunctionCallFromID(id dagger.FunctionCallID) *dagger.FunctionCall
- func LoadFunctionFromID(id dagger.FunctionID) *dagger.Function
- func LoadGeneratedCodeFromID(id dagger.GeneratedCodeID) *dagger.GeneratedCode
- func LoadGitModuleSourceFromID(id dagger.GitModuleSourceID) *dagger.GitModuleSource
- func LoadGitRefFromID(id dagger.GitRefID) *dagger.GitRef
- func LoadGitRepositoryFromID(id dagger.GitRepositoryID) *dagger.GitRepository
- func LoadHostFromID(id dagger.HostID) *dagger.Host
- func LoadInputTypeDefFromID(id dagger.InputTypeDefID) *dagger.InputTypeDef
- func LoadInterfaceTypeDefFromID(id dagger.InterfaceTypeDefID) *dagger.InterfaceTypeDef
- func LoadLabelFromID(id dagger.LabelID) *dagger.Label
- func LoadListTypeDefFromID(id dagger.ListTypeDefID) *dagger.ListTypeDef
- func LoadLocalModuleSourceFromID(id dagger.LocalModuleSourceID) *dagger.LocalModuleSource
- func LoadModuleDependencyFromID(id dagger.ModuleDependencyID) *dagger.ModuleDependency
- func LoadModuleFromID(id dagger.ModuleID) *dagger.Module
- func LoadModuleSourceFromID(id dagger.ModuleSourceID) *dagger.ModuleSource
- func LoadModuleSourceViewFromID(id dagger.ModuleSourceViewID) *dagger.ModuleSourceView
- func LoadObjectTypeDefFromID(id dagger.ObjectTypeDefID) *dagger.ObjectTypeDef
- func LoadPortFromID(id dagger.PortID) *dagger.Port
- func LoadSecretFromID(id dagger.SecretID) *dagger.Secret
- func LoadServiceFromID(id dagger.ServiceID) *dagger.Service
- func LoadSocketFromID(id dagger.SocketID) *dagger.Socket
- func LoadTerminalFromID(id dagger.TerminalID) *dagger.Terminal
- func LoadTypeDefFromID(id dagger.TypeDefID) *dagger.TypeDef
- func Module() *dagger.Module
- func ModuleDependency(source *dagger.ModuleSource, opts ...dagger.ModuleDependencyOpts) *dagger.ModuleDependency
- func ModuleSource(refString string, opts ...dagger.ModuleSourceOpts) *dagger.ModuleSource
- func Pipeline(name string, opts ...dagger.PipelineOpts) *dagger.Client
- func Secret(name string, opts ...dagger.SecretOpts) *dagger.Secret
- func SetSecret(name string, plaintext string) *dagger.Secret
- func Socket(id dagger.SocketID) *dagger.Socketdeprecated
- func TypeDef() *dagger.TypeDef
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuiltinContainer ¶ added in v0.10.0
Retrieves a container builtin to the engine.
func CacheVolume ¶
func CacheVolume(key string) *dagger.CacheVolume
Constructs a cache volume for a given cache key.
func CheckVersionCompatibility ¶
Checks if the current Dagger Engine is compatible with an SDK's required version.
func Container ¶
func Container(opts ...dagger.ContainerOpts) *dagger.Container
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.
func CurrentFunctionCall ¶
func CurrentFunctionCall() *dagger.FunctionCall
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.
func CurrentModule ¶
func CurrentModule() *dagger.CurrentModule
The module currently being served in the session, if any.
func CurrentTypeDefs ¶
The TypeDef representations of the objects currently being served in the session.
func DefaultPlatform ¶
The default platform of the engine.
func Directory ¶
func Directory(opts ...dagger.DirectoryOpts) *dagger.Directory
Creates an empty directory.
func GeneratedCode ¶
func GeneratedCode(code *dagger.Directory) *dagger.GeneratedCode
Create a code generation result, given a directory containing the generated code.
func Git ¶
func Git(url string, opts ...dagger.GitOpts) *dagger.GitRepository
Queries a Git repository.
func LoadCacheVolumeFromID ¶
func LoadCacheVolumeFromID(id dagger.CacheVolumeID) *dagger.CacheVolume
Load a CacheVolume from its ID.
func LoadContainerFromID ¶
func LoadContainerFromID(id dagger.ContainerID) *dagger.Container
Load a Container from its ID.
func LoadCurrentModuleFromID ¶ added in v0.9.8
func LoadCurrentModuleFromID(id dagger.CurrentModuleID) *dagger.CurrentModule
Load a CurrentModule from its ID.
func LoadDirectoryFromID ¶
func LoadDirectoryFromID(id dagger.DirectoryID) *dagger.Directory
Load a Directory from its ID.
func LoadEnvVariableFromID ¶ added in v0.9.7
func LoadEnvVariableFromID(id dagger.EnvVariableID) *dagger.EnvVariable
Load a EnvVariable from its ID.
func LoadFieldTypeDefFromID ¶ added in v0.9.7
func LoadFieldTypeDefFromID(id dagger.FieldTypeDefID) *dagger.FieldTypeDef
Load a FieldTypeDef from its ID.
func LoadFunctionArgFromID ¶
func LoadFunctionArgFromID(id dagger.FunctionArgID) *dagger.FunctionArg
Load a FunctionArg from its ID.
func LoadFunctionCallArgValueFromID ¶ added in v0.9.7
func LoadFunctionCallArgValueFromID(id dagger.FunctionCallArgValueID) *dagger.FunctionCallArgValue
Load a FunctionCallArgValue from its ID.
func LoadFunctionCallFromID ¶ added in v0.9.7
func LoadFunctionCallFromID(id dagger.FunctionCallID) *dagger.FunctionCall
Load a FunctionCall from its ID.
func LoadFunctionFromID ¶
func LoadFunctionFromID(id dagger.FunctionID) *dagger.Function
Load a Function from its ID.
func LoadGeneratedCodeFromID ¶
func LoadGeneratedCodeFromID(id dagger.GeneratedCodeID) *dagger.GeneratedCode
Load a GeneratedCode from its ID.
func LoadGitModuleSourceFromID ¶ added in v0.9.8
func LoadGitModuleSourceFromID(id dagger.GitModuleSourceID) *dagger.GitModuleSource
Load a GitModuleSource from its ID.
func LoadGitRefFromID ¶
Load a GitRef from its ID.
func LoadGitRepositoryFromID ¶
func LoadGitRepositoryFromID(id dagger.GitRepositoryID) *dagger.GitRepository
Load a GitRepository from its ID.
func LoadHostFromID ¶ added in v0.9.7
Load a Host from its ID.
func LoadInputTypeDefFromID ¶ added in v0.9.8
func LoadInputTypeDefFromID(id dagger.InputTypeDefID) *dagger.InputTypeDef
Load a InputTypeDef from its ID.
func LoadInterfaceTypeDefFromID ¶ added in v0.9.7
func LoadInterfaceTypeDefFromID(id dagger.InterfaceTypeDefID) *dagger.InterfaceTypeDef
Load a InterfaceTypeDef from its ID.
func LoadLabelFromID ¶ added in v0.9.7
Load a Label from its ID.
func LoadListTypeDefFromID ¶ added in v0.9.7
func LoadListTypeDefFromID(id dagger.ListTypeDefID) *dagger.ListTypeDef
Load a ListTypeDef from its ID.
func LoadLocalModuleSourceFromID ¶ added in v0.9.8
func LoadLocalModuleSourceFromID(id dagger.LocalModuleSourceID) *dagger.LocalModuleSource
Load a LocalModuleSource from its ID.
func LoadModuleDependencyFromID ¶ added in v0.9.8
func LoadModuleDependencyFromID(id dagger.ModuleDependencyID) *dagger.ModuleDependency
Load a ModuleDependency from its ID.
func LoadModuleFromID ¶
Load a Module from its ID.
func LoadModuleSourceFromID ¶ added in v0.9.8
func LoadModuleSourceFromID(id dagger.ModuleSourceID) *dagger.ModuleSource
Load a ModuleSource from its ID.
func LoadModuleSourceViewFromID ¶ added in v0.10.3
func LoadModuleSourceViewFromID(id dagger.ModuleSourceViewID) *dagger.ModuleSourceView
Load a ModuleSourceView from its ID.
func LoadObjectTypeDefFromID ¶ added in v0.9.7
func LoadObjectTypeDefFromID(id dagger.ObjectTypeDefID) *dagger.ObjectTypeDef
Load a ObjectTypeDef from its ID.
func LoadPortFromID ¶ added in v0.9.7
Load a Port from its ID.
func LoadSecretFromID ¶
Load a Secret from its ID.
func LoadServiceFromID ¶
Load a Service from its ID.
func LoadSocketFromID ¶
Load a Socket from its ID.
func LoadTerminalFromID ¶ added in v0.9.8
func LoadTerminalFromID(id dagger.TerminalID) *dagger.Terminal
Load a Terminal from its ID.
func LoadTypeDefFromID ¶
Load a TypeDef from its ID.
func ModuleDependency ¶ added in v0.9.8
func ModuleDependency(source *dagger.ModuleSource, opts ...dagger.ModuleDependencyOpts) *dagger.ModuleDependency
Create a new module dependency configuration from a module source and name
func ModuleSource ¶ added in v0.9.8
func ModuleSource(refString string, opts ...dagger.ModuleSourceOpts) *dagger.ModuleSource
Create a new module source instance from a source ref string.
func Pipeline ¶
func Pipeline(name string, opts ...dagger.PipelineOpts) *dagger.Client
Creates a named sub-pipeline.
func Secret ¶
func Secret(name string, opts ...dagger.SecretOpts) *dagger.Secret
Reference a secret by name.
func SetSecret ¶
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.
Types ¶
This section is empty.