dockersdk
This module has been generated via dagger init and serves as a reference tobasic module structure as you get started with Dagger.
Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.
The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.
Installation
dagger install github.com/quartz-technology/daggerverse/docker_sdk@2fe856d7b645e25ad51ee86f20204e973d86dbbe
Entrypoint
Return Type
Dockersdk !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
app | Directory | - | Source file of the Docker SDK, this path should never be changed nor set. |
Example
dagger -m github.com/quartz-technology/daggerverse/docker_sdk@2fe856d7b645e25ad51ee86f20204e973d86dbbe call \
func (m *myModule) example() *Dockersdk {
return dag.
Dockersdk()
}
@function
def example() -> dag.Dockersdk:
return (
dag.dockersdk()
)
@func()
example(): Dockersdk {
return dag
.dockersdk()
}
Types
Dockersdk 🔗
app() 🔗
Return Type
Directory !
Example
dagger -m github.com/quartz-technology/daggerverse/docker_sdk@2fe856d7b645e25ad51ee86f20204e973d86dbbe call \
app
func (m *myModule) example() *Directory {
return dag.
Dockersdk().
App()
}
@function
def example() -> dagger.Directory:
return (
dag.dockersdk()
.app()
)
@func()
example(): Directory {
return dag
.dockersdk()
.app()
}
requiredPaths() 🔗
Return Type
[String ! ] !
Example
dagger -m github.com/quartz-technology/daggerverse/docker_sdk@2fe856d7b645e25ad51ee86f20204e973d86dbbe call \
required-paths
func (m *myModule) example(ctx context.Context) []string {
return dag.
Dockersdk().
RequiredPaths(ctx)
}
@function
async def example() -> List[str]:
return await (
dag.dockersdk()
.required_paths()
)
@func()
async example(): Promise<string[]> {
return dag
.dockersdk()
.requiredPaths()
}
moduleRuntime() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
modSource | ModuleSource ! | - | No description provided |
introspectionJson | File ! | - | No description provided |
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, introspectionJson *File) *Container {
return dag.
Dockersdk().
ModuleRuntime(modSource, introspectionJson)
}
@function
def example(mod_source: dag.ModuleSource, introspection_json: dagger.File) -> dagger.Container:
return (
dag.dockersdk()
.module_runtime(mod_source, introspection_json)
)
@func()
example(modSource: ModuleSource, introspectionJson: File): Container {
return dag
.dockersdk()
.moduleRuntime(modSource, introspectionJson)
}
codegen() 🔗
The Docker SDK does not generate any code.
Return Type
GeneratedCode !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
modSource | ModuleSource ! | - | No description provided |
introspectionJson | File ! | - | No description provided |
Example
echo 'Custom types are not supported in shell examples'
func (m *myModule) example(modSource *ModuleSource, introspectionJson *File) *GeneratedCode {
return dag.
Dockersdk().
Codegen(modSource, introspectionJson)
}
@function
def example(mod_source: dag.ModuleSource, introspection_json: dagger.File) -> dag.GeneratedCode:
return (
dag.dockersdk()
.codegen(mod_source, introspection_json)
)
@func()
example(modSource: ModuleSource, introspectionJson: File): GeneratedCode {
return dag
.dockersdk()
.codegen(modSource, introspectionJson)
}