dagger

package module
v0.0.0-...-70bfc5e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var WithConn = dagger.WithConn

WithConn sets the engine connection explicitly

View Source
var WithEnvironmentVariable = dagger.WithEnvironmentVariable

WithEnvironmentVariable sets an environment variable in the CLI subprocess

View Source
var WithLoadWorkspaceModules = dagger.WithLoadWorkspaceModules

WithLoadWorkspaceModules opts this client into loading workspace modules based on the working directory when the session is created via the CLI.

View Source
var WithLogOutput = dagger.WithLogOutput

WithLogOutput sets the progress writer

View Source
var WithRunnerHost = dagger.WithRunnerHost

WithRunnerHost sets the runner host URL

View Source
var WithVerbosity = dagger.WithVerbosity

WithVerbosity sets the verbosity level for the progress output

View Source
var WithVersionOverride = dagger.WithVersionOverride

WithVersionOverride requests a specific schema version from the engine

View Source
var WithWorkdir = dagger.WithWorkdir

WithWorkdir sets the engine workdir

View Source
var WithWorkspace = dagger.WithWorkspace

WithWorkspace sets the workspace binding for the engine session

Functions

func Load

func Load[T Loadable[T]](ctx context.Context, c *Client, id ID) (T, error)

Load loads a node by its ID with type safety. It verifies that the node exists and matches the expected type before returning.

The type parameter can be a concrete type or an interface. The __typename check is done through the inline fragment so that interface loads succeed when the concrete type (e.g. "Impl") implements the expected interface (e.g. "CustomIface").

func Ref

func Ref[T Loadable[T]](c *Client, id ID) T

Ref returns a lazy reference to a node by its ID without making a network call. The returned value can be used to chain further queries.

func Tracer

func Tracer() trace.Tracer

Types

type Address

type Address struct {
	// contains filtered or unexported fields
}

A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.

func (*Address) AsNode

func (r *Address) AsNode() Node

AsNode returns this Address as a Node. This is a local type conversion — no GraphQL call.

func (*Address) Container

func (r *Address) Container() *Container

Load a container from the address.

func (*Address) Directory

func (r *Address) Directory(opts ...AddressDirectoryOpts) *Directory

Load a directory from the address.

func (*Address) File

func (r *Address) File(opts ...AddressFileOpts) *File

Load a file from the address.

func (*Address) GitRef

func (r *Address) GitRef() *GitRef

Load a git ref (branch, tag or commit) from the address.

func (*Address) GitRepository

func (r *Address) GitRepository() *GitRepository

Load a git repository from the address.

func (*Address) ID

func (r *Address) ID(ctx context.Context) (ID, error)

A unique identifier for this Address.

func (*Address) MarshalJSON

func (r *Address) MarshalJSON() ([]byte, error)

func (*Address) Secret

func (r *Address) Secret() *Secret

Load a secret from the address.

func (*Address) Service

func (r *Address) Service() *Service

Load a service from the address.

func (*Address) Socket

func (r *Address) Socket() *Socket

Load a local socket from the address.

func (*Address) Value

func (r *Address) Value(ctx context.Context) (string, error)

The address value

func (*Address) WithGraphQLQuery

func (r *Address) WithGraphQLQuery(q *querybuilder.Selection) *Address

func (*Address) XXX_GraphQLID

func (r *Address) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Address) XXX_GraphQLIDType

func (r *Address) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Address) XXX_GraphQLType

func (r *Address) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type AddressDirectoryOpts

type AddressDirectoryOpts struct {
	Exclude []string

	Include []string

	Gitignore bool

	NoCache bool
}

AddressDirectoryOpts contains options for Address.Directory

type AddressFileOpts

type AddressFileOpts struct {
	Exclude []string

	Include []string

	Gitignore bool

	NoCache bool
}

AddressFileOpts contains options for Address.File

type AddressID

type AddressID string

A unique identifier for an object.

type Arch

type Arch struct {
	// contains filtered or unexported fields
}

func (*Arch) AsNode

func (r *Arch) AsNode() Node

AsNode returns this Arch as a Node. This is a local type conversion — no GraphQL call.

func (*Arch) Gnu

func (r *Arch) Gnu(ctx context.Context) (string, error)

GNU returns the architecture in GNU/uname naming (e.g. "x86_64", "aarch64").

func (*Arch) ID

func (r *Arch) ID(ctx context.Context) (ID, error)

A unique identifier for this Arch.

func (*Arch) MarshalJSON

func (r *Arch) MarshalJSON() ([]byte, error)

func (*Arch) Microsoft

func (r *Arch) Microsoft(ctx context.Context) (string, error)

Microsoft returns the architecture in Microsoft naming (e.g. "x64", "arm64").

func (*Arch) Oci

func (r *Arch) Oci(ctx context.Context) (string, error)

OCI returns the architecture in OCI/Go naming (e.g. "amd64", "arm64").

func (*Arch) WithGraphQLQuery

func (r *Arch) WithGraphQLQuery(q *querybuilder.Selection) *Arch

func (*Arch) XXX_GraphQLID

func (r *Arch) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Arch) XXX_GraphQLIDType

func (r *Arch) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Arch) XXX_GraphQLType

func (r *Arch) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ArchID

type ArchID string

A unique identifier for an object.

type Archive

type Archive struct {
	// contains filtered or unexported fields
}

func (*Archive) AsNode

func (r *Archive) AsNode() Node

AsNode returns this Archive as a Node. This is a local type conversion — no GraphQL call.

func (*Archive) ID

func (r *Archive) ID(ctx context.Context) (ID, error)

A unique identifier for this Archive.

func (*Archive) MarshalJSON

func (r *Archive) MarshalJSON() ([]byte, error)

func (*Archive) Tar

func (r *Archive) Tar(directory *Directory, opts ...ArchiveTarOpts) *File

func (*Archive) Untar

func (r *Archive) Untar(file *File) *Directory

func (*Archive) WithGraphQLQuery

func (r *Archive) WithGraphQLQuery(q *querybuilder.Selection) *Archive

func (*Archive) XXX_GraphQLID

func (r *Archive) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Archive) XXX_GraphQLIDType

func (r *Archive) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Archive) XXX_GraphQLType

func (r *Archive) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

func (*Archive) Zip

func (r *Archive) Zip(directory *Directory) *File

type ArchiveID

type ArchiveID string

A unique identifier for an object.

type ArchiveOpts

ArchiveOpts contains options for Query.Archive

type ArchiveTarOpts

ArchiveTarOpts contains options for Archive.Tar

type BinaryOpts

type BinaryOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:179:2)
}

BinaryOpts contains options for Query.Binary

type Binding

type Binding struct {
	// contains filtered or unexported fields
}

func (*Binding) AsAddress

func (r *Binding) AsAddress() *Address

Retrieve the binding value, as type Address

func (*Binding) AsArch

func (r *Binding) AsArch() *Arch

Retrieve the binding value, as type Arch

func (*Binding) AsArchive

func (r *Binding) AsArchive() *Archive

Retrieve the binding value, as type Archive

func (*Binding) AsCacheVolume

func (r *Binding) AsCacheVolume() *CacheVolume

Retrieve the binding value, as type CacheVolume

func (*Binding) AsChangeset

func (r *Binding) AsChangeset() *Changeset

Retrieve the binding value, as type Changeset

func (*Binding) AsCheck

func (r *Binding) AsCheck() *Check

Retrieve the binding value, as type Check

func (*Binding) AsCheckGroup

func (r *Binding) AsCheckGroup() *CheckGroup

Retrieve the binding value, as type CheckGroup

func (*Binding) AsCloud

func (r *Binding) AsCloud() *Cloud

Retrieve the binding value, as type Cloud

func (*Binding) AsContainer

func (r *Binding) AsContainer() *Container

Retrieve the binding value, as type Container

func (*Binding) AsDiffStat

func (r *Binding) AsDiffStat() *DiffStat

Retrieve the binding value, as type DiffStat

func (*Binding) AsDirectory

func (r *Binding) AsDirectory() *Directory

Retrieve the binding value, as type Directory

func (*Binding) AsEnv

func (r *Binding) AsEnv() *Env

Retrieve the binding value, as type Env

func (*Binding) AsEnvFile

func (r *Binding) AsEnvFile() *EnvFile

Retrieve the binding value, as type EnvFile

func (*Binding) AsFile

func (r *Binding) AsFile() *File

Retrieve the binding value, as type File

func (*Binding) AsGenerator

func (r *Binding) AsGenerator() *Generator

Retrieve the binding value, as type Generator

func (*Binding) AsGeneratorGroup

func (r *Binding) AsGeneratorGroup() *GeneratorGroup

Retrieve the binding value, as type GeneratorGroup

func (*Binding) AsGitRef

func (r *Binding) AsGitRef() *GitRef

Retrieve the binding value, as type GitRef

func (*Binding) AsGitRepository

func (r *Binding) AsGitRepository() *GitRepository

Retrieve the binding value, as type GitRepository

func (*Binding) AsGo

func (r *Binding) AsGo() *Go

Retrieve the binding value, as type Go

func (*Binding) AsHTTPState

func (r *Binding) AsHTTPState() *HTTPState

Retrieve the binding value, as type HTTPState

func (*Binding) AsJSONValue

func (r *Binding) AsJSONValue() *JSONValue

Retrieve the binding value, as type JSONValue

func (*Binding) AsMise

func (r *Binding) AsMise() *Mise

Retrieve the binding value, as type Mise

func (*Binding) AsModule

func (r *Binding) AsModule() *Module

Retrieve the binding value, as type Module

func (*Binding) AsModuleConfigClient

func (r *Binding) AsModuleConfigClient() *ModuleConfigClient

Retrieve the binding value, as type ModuleConfigClient

func (*Binding) AsModuleSource

func (r *Binding) AsModuleSource() *ModuleSource

Retrieve the binding value, as type ModuleSource

func (*Binding) AsNode

func (r *Binding) AsNode() Node

AsNode returns this Binding as a Node. This is a local type conversion — no GraphQL call.

func (*Binding) AsSearchResult

func (r *Binding) AsSearchResult() *SearchResult

Retrieve the binding value, as type SearchResult

func (*Binding) AsSearchSubmatch

func (r *Binding) AsSearchSubmatch() *SearchSubmatch

Retrieve the binding value, as type SearchSubmatch

func (*Binding) AsSecret

func (r *Binding) AsSecret() *Secret

Retrieve the binding value, as type Secret

func (*Binding) AsService

func (r *Binding) AsService() *Service

Retrieve the binding value, as type Service

func (*Binding) AsSindri

func (r *Binding) AsSindri() *Sindri

Retrieve the binding value, as type Sindri

func (*Binding) AsSindriDev

func (r *Binding) AsSindriDev() *SindriDev

Retrieve the binding value, as type SindriDev

func (*Binding) AsSocket

func (r *Binding) AsSocket() *Socket

Retrieve the binding value, as type Socket

func (*Binding) AsStat

func (r *Binding) AsStat() *Stat

Retrieve the binding value, as type Stat

func (*Binding) AsString

func (r *Binding) AsString(ctx context.Context) (string, error)

Returns the binding's string value

func (*Binding) AsUp

func (r *Binding) AsUp() *Up

Retrieve the binding value, as type Up

func (*Binding) AsUpGroup

func (r *Binding) AsUpGroup() *UpGroup

Retrieve the binding value, as type UpGroup

func (*Binding) AsWolfi

func (r *Binding) AsWolfi() *Wolfi

Retrieve the binding value, as type Wolfi

func (*Binding) AsWorkspace

func (r *Binding) AsWorkspace() *Workspace

Retrieve the binding value, as type Workspace

func (*Binding) Digest

func (r *Binding) Digest(ctx context.Context) (string, error)

Returns the digest of the binding value

func (*Binding) ID

func (r *Binding) ID(ctx context.Context) (ID, error)

A unique identifier for this Binding.

func (*Binding) IsNull

func (r *Binding) IsNull(ctx context.Context) (bool, error)

Returns true if the binding is null

func (*Binding) MarshalJSON

func (r *Binding) MarshalJSON() ([]byte, error)

func (*Binding) Name

func (r *Binding) Name(ctx context.Context) (string, error)

Returns the binding name

func (*Binding) TypeName

func (r *Binding) TypeName(ctx context.Context) (string, error)

Returns the binding type

func (*Binding) WithGraphQLQuery

func (r *Binding) WithGraphQLQuery(q *querybuilder.Selection) *Binding

func (*Binding) XXX_GraphQLID

func (r *Binding) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Binding) XXX_GraphQLIDType

func (r *Binding) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Binding) XXX_GraphQLType

func (r *Binding) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type BindingID

type BindingID string

A unique identifier for an object.

type BuildArg

type BuildArg struct {
	// The build argument name.
	Name string `json:"name"`

	// The build argument value.
	Value string `json:"value"`
}

Key value object that represents a build argument.

type CacheSharingMode

type CacheSharingMode string

Sharing mode of the cache volume.

const (
	// Shares the cache volume amongst many build pipelines
	CacheSharingModeShared CacheSharingMode = "SHARED"

	// Keeps a cache volume for a single build pipeline
	CacheSharingModePrivate CacheSharingMode = "PRIVATE"

	// Shares the cache volume amongst many build pipelines, but will serialize the writes
	CacheSharingModeLocked CacheSharingMode = "LOCKED"
)

func (CacheSharingMode) IsEnum

func (CacheSharingMode) IsEnum()

func (*CacheSharingMode) MarshalJSON

func (v *CacheSharingMode) MarshalJSON() ([]byte, error)

func (CacheSharingMode) Name

func (v CacheSharingMode) Name() string

func (*CacheSharingMode) UnmarshalJSON

func (v *CacheSharingMode) UnmarshalJSON(dt []byte) error

func (CacheSharingMode) Value

func (v CacheSharingMode) Value() string

type CacheVolume

type CacheVolume struct {
	// contains filtered or unexported fields
}

A directory whose contents persist across runs.

func (*CacheVolume) AsNode

func (r *CacheVolume) AsNode() Node

AsNode returns this CacheVolume as a Node. This is a local type conversion — no GraphQL call.

func (*CacheVolume) ID

func (r *CacheVolume) ID(ctx context.Context) (ID, error)

A unique identifier for this CacheVolume.

func (*CacheVolume) MarshalJSON

func (r *CacheVolume) MarshalJSON() ([]byte, error)

func (*CacheVolume) WithGraphQLQuery

func (r *CacheVolume) WithGraphQLQuery(q *querybuilder.Selection) *CacheVolume

func (*CacheVolume) XXX_GraphQLID

func (r *CacheVolume) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*CacheVolume) XXX_GraphQLIDType

func (r *CacheVolume) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*CacheVolume) XXX_GraphQLType

func (r *CacheVolume) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type CacheVolumeID

type CacheVolumeID string

A unique identifier for an object.

type CacheVolumeOpts

type CacheVolumeOpts struct {
	// Identifier of the directory to use as the cache volume's root.
	Source *Directory
	// Sharing mode of the cache volume.
	//
	// Default: SHARED
	Sharing CacheSharingMode
	// A user:group to set for the cache volume root.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
}

CacheVolumeOpts contains options for Query.CacheVolume

type Changeset

type Changeset struct {
	// contains filtered or unexported fields
}

A comparison between two directories representing changes that can be applied.

func (*Changeset) AddedPaths

func (r *Changeset) AddedPaths(ctx context.Context) ([]string, error)

Files and directories that were added in the newer directory.

func (*Changeset) After

func (r *Changeset) After() *Directory

The newer/upper snapshot.

func (*Changeset) AsExportable

func (r *Changeset) AsExportable() Exportable

AsExportable returns this Changeset as a Exportable. This is a local type conversion — no GraphQL call.

func (*Changeset) AsNode

func (r *Changeset) AsNode() Node

AsNode returns this Changeset as a Node. This is a local type conversion — no GraphQL call.

func (*Changeset) AsPatch

func (r *Changeset) AsPatch() *File

Return a Git-compatible patch of the changes

func (*Changeset) AsSyncer

func (r *Changeset) AsSyncer() Syncer

AsSyncer returns this Changeset as a Syncer. This is a local type conversion — no GraphQL call.

func (*Changeset) Before

func (r *Changeset) Before() *Directory

The older/lower snapshot to compare against.

func (*Changeset) DiffStats

func (r *Changeset) DiffStats(ctx context.Context) ([]DiffStat, error)

Structured per-path diff statistics (kind and line counts) for this changeset.

func (*Changeset) Export

func (r *Changeset) Export(ctx context.Context, path string) (string, error)

Applies the diff represented by this changeset to a path on the host.

func (*Changeset) ID

func (r *Changeset) ID(ctx context.Context) (ID, error)

A unique identifier for this Changeset.

func (*Changeset) IsEmpty

func (r *Changeset) IsEmpty(ctx context.Context) (bool, error)

Returns true if the changeset is empty (i.e. there are no changes).

func (*Changeset) Layer

func (r *Changeset) Layer() *Directory

Return a snapshot containing only the created and modified files

func (*Changeset) MarshalJSON

func (r *Changeset) MarshalJSON() ([]byte, error)

func (*Changeset) ModifiedPaths

func (r *Changeset) ModifiedPaths(ctx context.Context) ([]string, error)

Files and directories that existed before and were updated in the newer directory.

func (*Changeset) RemovedPaths

func (r *Changeset) RemovedPaths(ctx context.Context) ([]string, error)

Files and directories that were removed. Directories are indicated by a trailing slash, and their child paths are not included.

func (*Changeset) Sync

func (r *Changeset) Sync(ctx context.Context) (*Changeset, error)

Force evaluation in the engine.

func (*Changeset) With

With calls the provided function with current Changeset.

This is useful for reusability and readability by not breaking the calling chain.

func (*Changeset) WithChangeset

func (r *Changeset) WithChangeset(changes *Changeset, opts ...ChangesetWithChangesetOpts) *Changeset

Add changes to an existing changeset

By default the operation will fail in case of conflicts, for instance a file modified in both changesets. The behavior can be adjusted using onConflict argument

func (*Changeset) WithChangesets

func (r *Changeset) WithChangesets(changes []*Changeset, opts ...ChangesetWithChangesetsOpts) *Changeset

Add changes from multiple changesets using git octopus merge strategy

This is more efficient than chaining multiple withChangeset calls when merging many changesets.

Only FAIL and FAIL_EARLY conflict strategies are supported (octopus merge cannot use -X ours/theirs).

func (*Changeset) WithGraphQLQuery

func (r *Changeset) WithGraphQLQuery(q *querybuilder.Selection) *Changeset

func (*Changeset) XXX_GraphQLID

func (r *Changeset) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Changeset) XXX_GraphQLIDType

func (r *Changeset) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Changeset) XXX_GraphQLType

func (r *Changeset) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ChangesetID

type ChangesetID string

A unique identifier for an object.

type ChangesetMergeConflict

type ChangesetMergeConflict string

Strategy to use when merging changesets with conflicting changes.

const (
	// Fail before attempting merge if file-level conflicts are detected
	ChangesetMergeConflictFailEarly ChangesetMergeConflict = "FAIL_EARLY"

	// Attempt the merge and fail if git merge fails due to conflicts
	ChangesetMergeConflictFail ChangesetMergeConflict = "FAIL"

	// Let git create conflict markers in files. For modify/delete conflicts, keeps the modified version. Fails on binary conflicts.
	ChangesetMergeConflictLeaveConflictMarkers ChangesetMergeConflict = "LEAVE_CONFLICT_MARKERS"

	// The conflict is resolved by applying the version of the calling changeset
	ChangesetMergeConflictPreferOurs ChangesetMergeConflict = "PREFER_OURS"

	// The conflict is resolved by applying the version of the other changeset
	ChangesetMergeConflictPreferTheirs ChangesetMergeConflict = "PREFER_THEIRS"
)

func (ChangesetMergeConflict) IsEnum

func (ChangesetMergeConflict) IsEnum()

func (*ChangesetMergeConflict) MarshalJSON

func (v *ChangesetMergeConflict) MarshalJSON() ([]byte, error)

func (ChangesetMergeConflict) Name

func (v ChangesetMergeConflict) Name() string

func (*ChangesetMergeConflict) UnmarshalJSON

func (v *ChangesetMergeConflict) UnmarshalJSON(dt []byte) error

func (ChangesetMergeConflict) Value

func (v ChangesetMergeConflict) Value() string

type ChangesetWithChangesetOpts

type ChangesetWithChangesetOpts struct {
	// What to do on a merge conflict
	//
	// Default: FAIL
	OnConflict ChangesetMergeConflict
}

ChangesetWithChangesetOpts contains options for Changeset.WithChangeset

type ChangesetWithChangesetsOpts

type ChangesetWithChangesetsOpts struct {
	// What to do on a merge conflict
	//
	// Default: FAIL
	OnConflict ChangesetsMergeConflict
}

ChangesetWithChangesetsOpts contains options for Changeset.WithChangesets

type ChangesetsMergeConflict

type ChangesetsMergeConflict string

Strategy to use when merging multiple changesets with git octopus merge.

const (
	// Fail before attempting merge if file-level conflicts are detected between any changesets
	ChangesetsMergeConflictFailEarly ChangesetsMergeConflict = "FAIL_EARLY"

	// Attempt the octopus merge and fail if git merge fails due to conflicts
	ChangesetsMergeConflictFail ChangesetsMergeConflict = "FAIL"
)

func (ChangesetsMergeConflict) IsEnum

func (ChangesetsMergeConflict) IsEnum()

func (*ChangesetsMergeConflict) MarshalJSON

func (v *ChangesetsMergeConflict) MarshalJSON() ([]byte, error)

func (ChangesetsMergeConflict) Name

func (*ChangesetsMergeConflict) UnmarshalJSON

func (v *ChangesetsMergeConflict) UnmarshalJSON(dt []byte) error

func (ChangesetsMergeConflict) Value

func (v ChangesetsMergeConflict) Value() string

type Check

type Check struct {
	// contains filtered or unexported fields
}

func (*Check) AsNode

func (r *Check) AsNode() Node

AsNode returns this Check as a Node. This is a local type conversion — no GraphQL call.

func (*Check) CheckType

func (r *Check) CheckType(ctx context.Context) (string, error)

The type of check: 'check' for annotated checks, 'generate' for generate-as-checks

func (*Check) Completed

func (r *Check) Completed(ctx context.Context) (bool, error)

Whether the check completed

func (*Check) Description

func (r *Check) Description(ctx context.Context) (string, error)

The description of the check

func (*Check) Error

func (r *Check) Error() *Error

If the check failed, this is the error

func (*Check) ID

func (r *Check) ID(ctx context.Context) (ID, error)

A unique identifier for this Check.

func (*Check) MarshalJSON

func (r *Check) MarshalJSON() ([]byte, error)

func (*Check) Name

func (r *Check) Name(ctx context.Context) (string, error)

Return the fully qualified name of the check

func (*Check) OriginalModule

func (r *Check) OriginalModule() *Module

The original module in which the check has been defined

func (*Check) Passed

func (r *Check) Passed(ctx context.Context) (bool, error)

Whether the check passed

func (*Check) Path

func (r *Check) Path(ctx context.Context) ([]string, error)

The path of the check within its module

func (*Check) ResultEmoji

func (r *Check) ResultEmoji(ctx context.Context) (string, error)

An emoji representing the result of the check

func (*Check) Run

func (r *Check) Run() *Check

Execute the check

func (*Check) With

func (r *Check) With(f WithCheckFunc) *Check

With calls the provided function with current Check.

This is useful for reusability and readability by not breaking the calling chain.

func (*Check) WithGraphQLQuery

func (r *Check) WithGraphQLQuery(q *querybuilder.Selection) *Check

func (*Check) XXX_GraphQLID

func (r *Check) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Check) XXX_GraphQLIDType

func (r *Check) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Check) XXX_GraphQLType

func (r *Check) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type CheckGroup

type CheckGroup struct {
	// contains filtered or unexported fields
}

func (*CheckGroup) AsNode

func (r *CheckGroup) AsNode() Node

AsNode returns this CheckGroup as a Node. This is a local type conversion — no GraphQL call.

func (*CheckGroup) ID

func (r *CheckGroup) ID(ctx context.Context) (ID, error)

A unique identifier for this CheckGroup.

func (*CheckGroup) List

func (r *CheckGroup) List(ctx context.Context) ([]Check, error)

Return a list of individual checks and their details

func (*CheckGroup) MarshalJSON

func (r *CheckGroup) MarshalJSON() ([]byte, error)

func (*CheckGroup) Report

func (r *CheckGroup) Report() *File

Generate a markdown report

func (*CheckGroup) Run

func (r *CheckGroup) Run(opts ...CheckGroupRunOpts) *CheckGroup

Execute all selected checks

func (*CheckGroup) With

With calls the provided function with current CheckGroup.

This is useful for reusability and readability by not breaking the calling chain.

func (*CheckGroup) WithGraphQLQuery

func (r *CheckGroup) WithGraphQLQuery(q *querybuilder.Selection) *CheckGroup

func (*CheckGroup) XXX_GraphQLID

func (r *CheckGroup) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*CheckGroup) XXX_GraphQLIDType

func (r *CheckGroup) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*CheckGroup) XXX_GraphQLType

func (r *CheckGroup) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type CheckGroupID

type CheckGroupID string

A unique identifier for an object.

type CheckGroupRunOpts

type CheckGroupRunOpts struct {
	// If true, stop running checks as soon as any check fails.
	FailFast bool
}

CheckGroupRunOpts contains options for CheckGroup.Run

type CheckID

type CheckID string

A unique identifier for an object.

type Client

type Client struct {
	*Query
	// contains filtered or unexported fields
}

Client is the Dagger Engine Client

func Connect

func Connect(ctx context.Context, opts ...ClientOpt) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Do

func (c *Client) Do(ctx context.Context, req *Request, resp *Response) error

Do executes a raw GraphQL request using the client's session

func (*Client) GraphQLClient

func (c *Client) GraphQLClient() graphql.Client

GraphQLClient returns the underlying graphql.Client

func (*Client) QueryBuilder

func (c *Client) QueryBuilder() *querybuilder.Selection

QueryBuilder returns the underlying query builder

type ClientFilesyncMirror

type ClientFilesyncMirror struct {
	// contains filtered or unexported fields
}

An internal persistent filesync mirror.

func (*ClientFilesyncMirror) AsNode

func (r *ClientFilesyncMirror) AsNode() Node

AsNode returns this ClientFilesyncMirror as a Node. This is a local type conversion — no GraphQL call.

func (*ClientFilesyncMirror) ID

A unique identifier for this ClientFilesyncMirror.

func (*ClientFilesyncMirror) MarshalJSON

func (r *ClientFilesyncMirror) MarshalJSON() ([]byte, error)

func (*ClientFilesyncMirror) WithGraphQLQuery

func (*ClientFilesyncMirror) XXX_GraphQLID

func (r *ClientFilesyncMirror) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ClientFilesyncMirror) XXX_GraphQLIDType

func (r *ClientFilesyncMirror) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ClientFilesyncMirror) XXX_GraphQLType

func (r *ClientFilesyncMirror) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ClientFilesyncMirrorID

type ClientFilesyncMirrorID string

A unique identifier for an object.

type ClientOpt

type ClientOpt = dagger.ClientOpt

ClientOpt holds a client option

type Cloud

type Cloud struct {
	// contains filtered or unexported fields
}

Dagger Cloud configuration and state

func (*Cloud) AsNode

func (r *Cloud) AsNode() Node

AsNode returns this Cloud as a Node. This is a local type conversion — no GraphQL call.

func (*Cloud) ID

func (r *Cloud) ID(ctx context.Context) (ID, error)

A unique identifier for this Cloud.

func (*Cloud) MarshalJSON

func (r *Cloud) MarshalJSON() ([]byte, error)

func (*Cloud) TraceURL

func (r *Cloud) TraceURL(ctx context.Context) (string, error)

The trace URL for the current session

func (*Cloud) WithGraphQLQuery

func (r *Cloud) WithGraphQLQuery(q *querybuilder.Selection) *Cloud

func (*Cloud) XXX_GraphQLID

func (r *Cloud) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Cloud) XXX_GraphQLIDType

func (r *Cloud) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Cloud) XXX_GraphQLType

func (r *Cloud) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type CloudID

type CloudID string

A unique identifier for an object.

type Container

type Container struct {
	// contains filtered or unexported fields
}

An OCI-compatible container, also known as a Docker container.

func (*Container) AsExportable

func (r *Container) AsExportable() Exportable

AsExportable returns this Container as a Exportable. This is a local type conversion — no GraphQL call.

func (*Container) AsNode

func (r *Container) AsNode() Node

AsNode returns this Container as a Node. This is a local type conversion — no GraphQL call.

func (*Container) AsService

func (r *Container) AsService(opts ...ContainerAsServiceOpts) *Service

Turn the container into a Service.

Be sure to set any exposed ports before this conversion.

func (*Container) AsSyncer

func (r *Container) AsSyncer() Syncer

AsSyncer returns this Container as a Syncer. This is a local type conversion — no GraphQL call.

func (*Container) AsTarball

func (r *Container) AsTarball(opts ...ContainerAsTarballOpts) *File

Package the container state as an OCI image, and return it as a tar archive

func (*Container) CombinedOutput

func (r *Container) CombinedOutput(ctx context.Context) (string, error)

The combined buffered standard output and standard error stream of the last executed command

Returns an error if no command was executed

func (*Container) DefaultArgs

func (r *Container) DefaultArgs(ctx context.Context) ([]string, error)

Return the container's default arguments.

func (*Container) Directory

func (r *Container) Directory(path string, opts ...ContainerDirectoryOpts) *Directory

Retrieve a directory from the container's root filesystem

Mounts are included.

func (*Container) DockerHealthcheck

func (r *Container) DockerHealthcheck() *HealthcheckConfig

Retrieves this container's configured docker healthcheck.

func (*Container) Entrypoint

func (r *Container) Entrypoint(ctx context.Context) ([]string, error)

Return the container's OCI entrypoint.

func (*Container) EnvVariable

func (r *Container) EnvVariable(ctx context.Context, name string) (string, error)

Retrieves the value of the specified persistent environment variable.

func (*Container) EnvVariables

func (r *Container) EnvVariables(ctx context.Context) ([]EnvVariable, error)

Retrieves the list of persistent environment variables configured on the container.

func (*Container) Exists

func (r *Container) Exists(ctx context.Context, path string, opts ...ContainerExistsOpts) (bool, error)

check if a file or directory exists

func (*Container) ExitCode

func (r *Container) ExitCode(ctx context.Context) (int, error)

The exit code of the last executed command

Returns an error if no command was executed

func (*Container) ExperimentalWithAllGPUs

func (r *Container) ExperimentalWithAllGPUs() *Container

EXPERIMENTAL API! Subject to change/removal at any time.

Configures all available GPUs on the host to be accessible to this container.

This currently works for Nvidia devices only.

func (*Container) ExperimentalWithGPU

func (r *Container) ExperimentalWithGPU(devices []string) *Container

EXPERIMENTAL API! Subject to change/removal at any time.

Configures the provided list of devices to be accessible to this container.

This currently works for Nvidia devices only.

func (*Container) Export

func (r *Container) Export(ctx context.Context, path string, opts ...ContainerExportOpts) (string, error)

Writes the container as an OCI tarball to the destination file path on the host.

It can also export platform variants.

func (*Container) ExportImage

func (r *Container) ExportImage(ctx context.Context, name string, opts ...ContainerExportImageOpts) error

Exports the container as an image to the host's container image store.

func (*Container) ExposedPorts

func (r *Container) ExposedPorts(ctx context.Context) ([]Port, error)

Retrieves the list of exposed ports.

This includes ports already exposed by the image, even if not explicitly added with dagger.

func (*Container) File

func (r *Container) File(path string, opts ...ContainerFileOpts) *File

Retrieves a file at the given path.

Mounts are included.

func (*Container) From

func (r *Container) From(address string, opts ...ContainerFromOpts) *Container

Download a container image, and apply it to the container state. All previous state will be lost.

func (*Container) ID

func (r *Container) ID(ctx context.Context) (ID, error)

A unique identifier for this Container.

func (*Container) ImageRef

func (r *Container) ImageRef(ctx context.Context) (string, error)

The unique image reference which can only be retrieved immediately after the 'Container.From' call.

func (*Container) Import

func (r *Container) Import(source *File, opts ...ContainerImportOpts) *Container

Reads the container from an OCI tarball.

func (*Container) Label

func (r *Container) Label(ctx context.Context, name string) (string, error)

Retrieves the value of the specified label.

func (*Container) Labels

func (r *Container) Labels(ctx context.Context) ([]Label, error)

Retrieves the list of labels passed to container.

func (*Container) MarshalJSON

func (r *Container) MarshalJSON() ([]byte, error)

func (*Container) Mounts

func (r *Container) Mounts(ctx context.Context) ([]string, error)

Retrieves the list of paths where a directory is mounted.

func (*Container) Platform

func (r *Container) Platform(ctx context.Context) (Platform, error)

The platform this container executes and publishes as.

func (*Container) Publish

func (r *Container) Publish(ctx context.Context, address string, opts ...ContainerPublishOpts) (string, error)

Package the container state as an OCI image, and publish it to a registry

Returns the fully qualified address of the published image, with digest

func (*Container) Rootfs

func (r *Container) Rootfs() *Directory

Return a snapshot of the container's root filesystem. The snapshot can be modified then written back using withRootfs. Use that method for filesystem modifications.

func (*Container) Stat

func (r *Container) Stat(path string, opts ...ContainerStatOpts) *Stat

Return file status

func (*Container) Stderr

func (r *Container) Stderr(ctx context.Context) (string, error)

The buffered standard error stream of the last executed command

Returns an error if no command was executed

func (*Container) Stdout

func (r *Container) Stdout(ctx context.Context) (string, error)

The buffered standard output stream of the last executed command

Returns an error if no command was executed

func (*Container) Sync

func (r *Container) Sync(ctx context.Context) (*Container, error)

Forces evaluation of the pipeline in the engine.

It doesn't run the default command if no exec has been set.

func (*Container) Terminal

func (r *Container) Terminal(opts ...ContainerTerminalOpts) *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).

func (*Container) Up

func (r *Container) Up(ctx context.Context, opts ...ContainerUpOpts) error

Starts a Service and creates a tunnel that forwards traffic from the caller's network to that service.

Be sure to set any exposed ports before calling this api.

func (*Container) User

func (r *Container) User(ctx context.Context) (string, error)

Retrieves the user to be set for all commands.

func (*Container) With

With calls the provided function with current Container.

This is useful for reusability and readability by not breaking the calling chain.

func (*Container) WithAnnotation

func (r *Container) WithAnnotation(name string, value string) *Container

Retrieves this container plus the given OCI annotation.

func (*Container) WithDefaultArgs

func (r *Container) WithDefaultArgs(args []string) *Container

Configures default arguments for future commands. Like CMD in Dockerfile.

func (*Container) WithDefaultTerminalCmd

func (r *Container) WithDefaultTerminalCmd(args []string, opts ...ContainerWithDefaultTerminalCmdOpts) *Container

Set the default command to invoke for the container's terminal API.

func (*Container) WithDirectory

func (r *Container) WithDirectory(path string, source *Directory, opts ...ContainerWithDirectoryOpts) *Container

Return a new container snapshot, with a directory added to its filesystem

func (*Container) WithDockerHealthcheck

func (r *Container) WithDockerHealthcheck(args []string, opts ...ContainerWithDockerHealthcheckOpts) *Container

Retrieves this container with the specificed docker healtcheck command set.

func (*Container) WithEntrypoint

func (r *Container) WithEntrypoint(args []string, opts ...ContainerWithEntrypointOpts) *Container

Set an OCI-style entrypoint. It will be included in the container's OCI configuration. Note, withExec ignores the entrypoint by default.

func (*Container) WithEnvFileVariables

func (r *Container) WithEnvFileVariables(source *EnvFile) *Container

Export environment variables from an env-file to the container.

func (*Container) WithEnvVariable

func (r *Container) WithEnvVariable(name string, value string, opts ...ContainerWithEnvVariableOpts) *Container

Set a new environment variable in the container.

func (*Container) WithError

func (r *Container) WithError(err string) *Container

Raise an error.

func (*Container) WithExec

func (r *Container) WithExec(args []string, opts ...ContainerWithExecOpts) *Container

Execute a command in the container, and return a new snapshot of the container state after execution.

func (*Container) WithExposedPort

func (r *Container) WithExposedPort(port int, opts ...ContainerWithExposedPortOpts) *Container

Expose a network port. Like EXPOSE in Dockerfile (but with healthcheck support)

Exposed ports serve two purposes:

- For health checks and introspection, when running services

- For setting the EXPOSE OCI field when publishing the container

func (*Container) WithFile

func (r *Container) WithFile(path string, source *File, opts ...ContainerWithFileOpts) *Container

Return a container snapshot with a file added

func (*Container) WithFiles

func (r *Container) WithFiles(path string, sources []*File, opts ...ContainerWithFilesOpts) *Container

Retrieves this container plus the contents of the given files copied to the given path.

func (*Container) WithGraphQLQuery

func (r *Container) WithGraphQLQuery(q *querybuilder.Selection) *Container

func (*Container) WithLabel

func (r *Container) WithLabel(name string, value string) *Container

Retrieves this container plus the given label.

func (*Container) WithMountedCache

func (r *Container) WithMountedCache(path string, cache *CacheVolume, opts ...ContainerWithMountedCacheOpts) *Container

Retrieves this container plus a cache volume mounted at the given path.

func (*Container) WithMountedDirectory

func (r *Container) WithMountedDirectory(path string, source *Directory, opts ...ContainerWithMountedDirectoryOpts) *Container

Retrieves this container plus a directory mounted at the given path.

func (*Container) WithMountedFile

func (r *Container) WithMountedFile(path string, source *File, opts ...ContainerWithMountedFileOpts) *Container

Retrieves this container plus a file mounted at the given path.

func (*Container) WithMountedSecret

func (r *Container) WithMountedSecret(path string, source *Secret, opts ...ContainerWithMountedSecretOpts) *Container

Retrieves this container plus a secret mounted into a file at the given path.

func (*Container) WithMountedTemp

func (r *Container) WithMountedTemp(path string, opts ...ContainerWithMountedTempOpts) *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.

func (*Container) WithNewFile

func (r *Container) WithNewFile(path string, contents string, opts ...ContainerWithNewFileOpts) *Container

Return a new container snapshot, with a file added to its filesystem with text content

func (*Container) WithRegistryAuth

func (r *Container) WithRegistryAuth(address string, username string, secret *Secret) *Container

Attach credentials for future publishing to a registry. Use in combination with publish

func (*Container) WithRootfs

func (r *Container) WithRootfs(directory *Directory) *Container

Change the container's root filesystem. The previous root filesystem will be lost.

func (*Container) WithSecretVariable

func (r *Container) WithSecretVariable(name string, secret *Secret) *Container

Set a new environment variable, using a secret value

func (*Container) WithServiceBinding

func (r *Container) WithServiceBinding(alias string, service *Service) *Container

Establish a runtime dependency from a container to a network service.

The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set.

The service will be reachable from the container via the provided hostname alias.

The service dependency will also convey to any files or directories produced by the container.

func (r *Container) WithSymlink(target string, linkName string, opts ...ContainerWithSymlinkOpts) *Container

Return a snapshot with a symlink

func (*Container) WithUnixSocket

func (r *Container) WithUnixSocket(path string, source *Socket, opts ...ContainerWithUnixSocketOpts) *Container

Retrieves this container plus a socket forwarded to the given Unix socket path.

func (*Container) WithUser

func (r *Container) WithUser(name string) *Container

Retrieves this container with a different command user.

func (*Container) WithVolatileVariable

func (r *Container) WithVolatileVariable(name string, value string) *Container

Set a new non-secret environment variable for future execs without invalidating exec cache when only its value changes.

This is an expert-only escape hatch. If a volatile value affects observable exec results, stale cached results may be reused.

func (*Container) WithWorkdir

func (r *Container) WithWorkdir(path string, opts ...ContainerWithWorkdirOpts) *Container

Change the container's working directory. Like WORKDIR in Dockerfile.

func (*Container) WithoutAnnotation

func (r *Container) WithoutAnnotation(name string) *Container

Retrieves this container minus the given OCI annotation.

func (*Container) WithoutDefaultArgs

func (r *Container) WithoutDefaultArgs() *Container

Remove the container's default arguments.

func (*Container) WithoutDirectory

func (r *Container) WithoutDirectory(path string, opts ...ContainerWithoutDirectoryOpts) *Container

Return a new container snapshot, with a directory removed from its filesystem

func (*Container) WithoutDockerHealthcheck

func (r *Container) WithoutDockerHealthcheck() *Container

Retrieves this container without a configured docker healtcheck command.

func (*Container) WithoutEntrypoint

func (r *Container) WithoutEntrypoint(opts ...ContainerWithoutEntrypointOpts) *Container

Reset the container's OCI entrypoint.

func (*Container) WithoutEnvVariable

func (r *Container) WithoutEnvVariable(name string) *Container

Retrieves this container minus the given environment variable.

func (*Container) WithoutExposedPort

func (r *Container) WithoutExposedPort(port int, opts ...ContainerWithoutExposedPortOpts) *Container

Unexpose a previously exposed port.

func (*Container) WithoutFile

func (r *Container) WithoutFile(path string, opts ...ContainerWithoutFileOpts) *Container

Retrieves this container with the file at the given path removed.

func (*Container) WithoutFiles

func (r *Container) WithoutFiles(paths []string, opts ...ContainerWithoutFilesOpts) *Container

Return a new container spanshot with specified files removed

func (*Container) WithoutLabel

func (r *Container) WithoutLabel(name string) *Container

Retrieves this container minus the given environment label.

func (*Container) WithoutMount

func (r *Container) WithoutMount(path string, opts ...ContainerWithoutMountOpts) *Container

Retrieves this container after unmounting everything at the given path.

func (*Container) WithoutRegistryAuth

func (r *Container) WithoutRegistryAuth(address string) *Container

Retrieves this container without the registry authentication of a given address.

func (*Container) WithoutSecretVariable

func (r *Container) WithoutSecretVariable(name string) *Container

Retrieves this container minus the given environment variable containing the secret.

func (*Container) WithoutUnixSocket

func (r *Container) WithoutUnixSocket(path string, opts ...ContainerWithoutUnixSocketOpts) *Container

Retrieves this container with a previously added Unix socket removed.

func (*Container) WithoutUser

func (r *Container) WithoutUser() *Container

Retrieves this container with an unset command user.

Should default to root.

func (*Container) WithoutVolatileVariable

func (r *Container) WithoutVolatileVariable(name string) *Container

Retrieves this container minus the given volatile environment variable.

func (*Container) WithoutWorkdir

func (r *Container) WithoutWorkdir() *Container

Unset the container's working directory.

Should default to "/".

func (*Container) Workdir

func (r *Container) Workdir(ctx context.Context) (string, error)

Retrieves the working directory for all commands.

func (*Container) XXX_GraphQLID

func (r *Container) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Container) XXX_GraphQLIDType

func (r *Container) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Container) XXX_GraphQLType

func (r *Container) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ContainerAsServiceOpts

type ContainerAsServiceOpts struct {
	// Command to run instead of the container's default command (e.g., ["go", "run", "main.go"]).
	//
	// If empty, the container's default command is used.
	Args []string
	// If the container has an entrypoint, prepend it to the args.
	UseEntrypoint bool
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
	// Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
	// If set, skip the automatic init process injected into containers by default.
	//
	// This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
	NoInit bool
}

ContainerAsServiceOpts contains options for Container.AsService

type ContainerAsTarballOpts

type ContainerAsTarballOpts struct {
	// Identifiers for other platform specific containers.
	//
	// Used for multi-platform images.
	PlatformVariants []*Container
	// Force each layer of the image to use the specified compression algorithm.
	//
	// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
	ForcedCompression ImageLayerCompression
	// Use the specified media types for the image's layers.
	//
	// Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
	//
	// Default: OCIMediaTypes
	MediaTypes ImageMediaTypes
}

ContainerAsTarballOpts contains options for Container.AsTarball

type ContainerDirectoryOpts

type ContainerDirectoryOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerDirectoryOpts contains options for Container.Directory

type ContainerExistsOpts

type ContainerExistsOpts struct {
	// If specified, also validate the type of file (e.g. "REGULAR_TYPE", "DIRECTORY_TYPE", or "SYMLINK_TYPE").
	ExpectedType ExistsType
	// If specified, do not follow symlinks.
	DoNotFollowSymlinks bool
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerExistsOpts contains options for Container.Exists

type ContainerExportImageOpts

type ContainerExportImageOpts struct {
	// Identifiers for other platform specific containers.
	//
	// Used for multi-platform image.
	PlatformVariants []*Container
	// Force each layer of the exported image to use the specified compression algorithm.
	//
	// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
	ForcedCompression ImageLayerCompression
	// Use the specified media types for the exported image's layers.
	//
	// Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
	//
	// Default: OCIMediaTypes
	MediaTypes ImageMediaTypes
}

ContainerExportImageOpts contains options for Container.ExportImage

type ContainerExportOpts

type ContainerExportOpts struct {
	// Identifiers for other platform specific containers.
	//
	// Used for multi-platform image.
	PlatformVariants []*Container
	// Force each layer of the exported image to use the specified compression algorithm.
	//
	// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
	ForcedCompression ImageLayerCompression
	// Use the specified media types for the exported image's layers.
	//
	// Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
	//
	// Default: OCIMediaTypes
	MediaTypes ImageMediaTypes
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerExportOpts contains options for Container.Export

type ContainerFileOpts

type ContainerFileOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerFileOpts contains options for Container.File

type ContainerFromOpts

type ContainerFromOpts struct {
	// Service to use as the registry endpoint for the image address.
	//
	// The service will be started only for this pull.
	RegistryService *Service
}

ContainerFromOpts contains options for Container.From

type ContainerID

type ContainerID string

A unique identifier for an object.

type ContainerImportOpts

type ContainerImportOpts struct {
	// Identifies the tag to import from the archive, if the archive bundles multiple tags.
	Tag string
}

ContainerImportOpts contains options for Container.Import

type ContainerOpts

type ContainerOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:32:2)

	Module string // sindri-dev (../../.dagger/main.go:34:2)
}

ContainerOpts contains options for Query.Container

type ContainerPublishOpts

type ContainerPublishOpts struct {
	// Identifiers for other platform specific containers.
	//
	// Used for multi-platform image.
	PlatformVariants []*Container
	// Force each layer of the published image to use the specified compression algorithm.
	//
	// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
	ForcedCompression ImageLayerCompression
	// Use the specified media types for the published image's layers.
	//
	// Defaults to "OCI", which is compatible with most recent registries, but "Docker" may be needed for older registries without OCI support.
	//
	// Default: OCIMediaTypes
	MediaTypes ImageMediaTypes
	// Service to use as the registry endpoint for the image address.
	//
	// The service will be started only for this push.
	RegistryService *Service
}

ContainerPublishOpts contains options for Container.Publish

type ContainerStatOpts

type ContainerStatOpts struct {
	// If specified, do not follow symlinks.
	DoNotFollowSymlinks bool
}

ContainerStatOpts contains options for Container.Stat

type ContainerTerminalOpts

type ContainerTerminalOpts struct {
	// If set, override the container's default terminal command and invoke these command arguments instead.
	Cmd []string
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
}

ContainerTerminalOpts contains options for Container.Terminal

type ContainerUpOpts

type ContainerUpOpts struct {
	// Bind each tunnel port to a random port on the host.
	Random bool
	// List of frontend/backend port mappings to forward.
	//
	// Frontend is the port accepting traffic on the host, backend is the service port.
	Ports []PortForward
	// Command to run instead of the container's default command (e.g., ["go", "run", "main.go"]).
	//
	// If empty, the container's default command is used.
	Args []string
	// If the container has an entrypoint, prepend it to the args.
	UseEntrypoint bool
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
	// Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
	// If set, skip the automatic init process injected into containers by default.
	//
	// This should only be used if the user requires that their exec process be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
	NoInit bool
}

ContainerUpOpts contains options for Container.Up

type ContainerWithDefaultTerminalCmdOpts

type ContainerWithDefaultTerminalCmdOpts struct {
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
}

ContainerWithDefaultTerminalCmdOpts contains options for Container.WithDefaultTerminalCmd

type ContainerWithDirectoryOpts

type ContainerWithDirectoryOpts struct {
	// Patterns to exclude in the written directory (e.g. ["node_modules/**", ".gitignore", ".git/"]).
	Exclude []string
	// Patterns to include in the written directory (e.g. ["*.go", "go.mod", "go.sum"]).
	Include []string
	// Apply .gitignore rules when writing the directory.
	Gitignore bool
	// A user:group to set for the directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool

	Permissions int
}

ContainerWithDirectoryOpts contains options for Container.WithDirectory

type ContainerWithDockerHealthcheckOpts

type ContainerWithDockerHealthcheckOpts struct {
	// When true, command must be a single element, which is run using the container's shell
	Shell bool
	// Interval between running healthcheck. Example: "30s"
	Interval string
	// Healthcheck timeout. Example: "3s"
	Timeout string
	// StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example: "0s"
	StartPeriod string
	// StartInterval configures the duration between checks during the startup phase. Example: "5s"
	StartInterval string
	// The maximum number of consecutive failures before the container is marked as unhealthy. Example: "3"
	Retries int
}

ContainerWithDockerHealthcheckOpts contains options for Container.WithDockerHealthcheck

type ContainerWithEntrypointOpts

type ContainerWithEntrypointOpts struct {
	// Don't reset the default arguments when setting the entrypoint. By default it is reset, since entrypoint and default args are often tightly coupled.
	KeepDefaultArgs bool
}

ContainerWithEntrypointOpts contains options for Container.WithEntrypoint

type ContainerWithEnvVariableOpts

type ContainerWithEnvVariableOpts struct {
	// Replace "${VAR}" or "$VAR" in the value according to the current environment variables defined in the container (e.g. "/opt/bin:$PATH").
	Expand bool
}

ContainerWithEnvVariableOpts contains options for Container.WithEnvVariable

type ContainerWithExecOpts

type ContainerWithExecOpts struct {
	// Apply the OCI entrypoint, if present, by prepending it to the args. Ignored by default.
	UseEntrypoint bool
	// Content to write to the command's standard input. Example: "Hello world")
	Stdin string
	// Redirect the command's standard input from a file in the container. Example: "./stdin.txt"
	RedirectStdin string
	// Redirect the command's standard output to a file in the container. Example: "./stdout.txt"
	RedirectStdout string
	// Redirect the command's standard error to a file in the container. Example: "./stderr.txt"
	RedirectStderr string
	// Exit codes this command is allowed to exit with without error
	//
	// Default: SUCCESS
	Expect ReturnType
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. Like --privileged in Docker
	//
	// DANGER: this grants the command full access to the host system. Only use when 1) you trust the command being executed and 2) you specifically need this level of access.
	InsecureRootCapabilities bool
	// Replace "${VAR}" or "$VAR" in the args according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
	// Skip the automatic init process injected into containers by default.
	//
	// Only use this if you specifically need the command to be pid 1 in the container. Otherwise it may result in unexpected behavior. If you're not sure, you don't need this.
	NoInit bool
}

ContainerWithExecOpts contains options for Container.WithExec

type ContainerWithExposedPortOpts

type ContainerWithExposedPortOpts struct {
	// Network protocol. Example: "tcp"
	//
	// Default: TCP
	Protocol NetworkProtocol
	// Port description. Example: "payment API endpoint"
	Description string
	// Skip the health check when run as a service.
	ExperimentalSkipHealthcheck bool
}

ContainerWithExposedPortOpts contains options for Container.WithExposedPort

type ContainerWithFileOpts

type ContainerWithFileOpts struct {
	// Permissions of the new file. Example: 0600
	Permissions int
	// A user:group to set for the file.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithFileOpts contains options for Container.WithFile

type ContainerWithFilesOpts

type ContainerWithFilesOpts struct {
	// Permission given to the copied files (e.g., 0600).
	Permissions int
	// A user:group to set for the files.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithFilesOpts contains options for Container.WithFiles

type ContainerWithMountedCacheOpts

type ContainerWithMountedCacheOpts struct {
	// Identifier of the directory to use as the cache volume's root.
	Source *Directory
	// Sharing mode of the cache volume.
	//
	// Default: SHARED
	Sharing CacheSharingMode
	// A user:group to set for the mounted cache directory.
	//
	// Note that this changes the ownership of the specified mount along with the initial filesystem provided by source (if any). It does not have any effect if/when the cache has already been created.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithMountedCacheOpts contains options for Container.WithMountedCache

type ContainerWithMountedDirectoryOpts

type ContainerWithMountedDirectoryOpts struct {
	// A user:group to set for the mounted directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Mount the directory read-only.
	ReadOnly bool
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithMountedDirectoryOpts contains options for Container.WithMountedDirectory

type ContainerWithMountedFileOpts

type ContainerWithMountedFileOpts struct {
	// A user or user:group to set for the mounted file.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithMountedFileOpts contains options for Container.WithMountedFile

type ContainerWithMountedSecretOpts

type ContainerWithMountedSecretOpts struct {
	// A user:group to set for the mounted secret.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Permission given to the mounted secret (e.g., 0600).
	//
	// This option requires an owner to be set to be active.
	//
	// Default: 256
	Mode int
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithMountedSecretOpts contains options for Container.WithMountedSecret

type ContainerWithMountedTempOpts

type ContainerWithMountedTempOpts struct {
	// Size of the temporary directory in bytes.
	Size int
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithMountedTempOpts contains options for Container.WithMountedTemp

type ContainerWithNewFileOpts

type ContainerWithNewFileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
	// A user:group to set for the file.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithNewFileOpts contains options for Container.WithNewFile

type ContainerWithSymlinkOpts

type ContainerWithSymlinkOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithSymlinkOpts contains options for Container.WithSymlink

type ContainerWithUnixSocketOpts

type ContainerWithUnixSocketOpts struct {
	// A user:group to set for the mounted socket.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithUnixSocketOpts contains options for Container.WithUnixSocket

type ContainerWithWorkdirOpts

type ContainerWithWorkdirOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithWorkdirOpts contains options for Container.WithWorkdir

type ContainerWithoutDirectoryOpts

type ContainerWithoutDirectoryOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithoutDirectoryOpts contains options for Container.WithoutDirectory

type ContainerWithoutEntrypointOpts

type ContainerWithoutEntrypointOpts struct {
	// Don't remove the default arguments when unsetting the entrypoint.
	KeepDefaultArgs bool
}

ContainerWithoutEntrypointOpts contains options for Container.WithoutEntrypoint

type ContainerWithoutExposedPortOpts

type ContainerWithoutExposedPortOpts struct {
	// Port protocol to unexpose
	//
	// Default: TCP
	Protocol NetworkProtocol
}

ContainerWithoutExposedPortOpts contains options for Container.WithoutExposedPort

type ContainerWithoutFileOpts

type ContainerWithoutFileOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithoutFileOpts contains options for Container.WithoutFile

type ContainerWithoutFilesOpts

type ContainerWithoutFilesOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of paths according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
	Expand bool
}

ContainerWithoutFilesOpts contains options for Container.WithoutFiles

type ContainerWithoutMountOpts

type ContainerWithoutMountOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithoutMountOpts contains options for Container.WithoutMount

type ContainerWithoutUnixSocketOpts

type ContainerWithoutUnixSocketOpts struct {
	// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
	Expand bool
}

ContainerWithoutUnixSocketOpts contains options for Container.WithoutUnixSocket

type CurrentModule

type CurrentModule struct {
	// contains filtered or unexported fields
}

Reflective module API provided to functions at runtime.

func (*CurrentModule) AsNode

func (r *CurrentModule) AsNode() Node

AsNode returns this CurrentModule as a Node. This is a local type conversion — no GraphQL call.

func (*CurrentModule) Dependencies

func (r *CurrentModule) Dependencies(ctx context.Context) ([]Module, error)

The dependencies of the module.

func (*CurrentModule) GeneratedContextDirectory

func (r *CurrentModule) GeneratedContextDirectory() *Directory

The generated files and directories made on top of the module source's context directory.

func (*CurrentModule) Generators

Return all generators defined by the module

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*CurrentModule) ID

func (r *CurrentModule) ID(ctx context.Context) (ID, error)

A unique identifier for this CurrentModule.

func (*CurrentModule) MarshalJSON

func (r *CurrentModule) MarshalJSON() ([]byte, error)

func (*CurrentModule) Name

func (r *CurrentModule) Name(ctx context.Context) (string, error)

The name of the module being executed in

func (*CurrentModule) Source

func (r *CurrentModule) Source() *Directory

The directory containing the module's source code loaded into the engine (plus any generated code that may have been created).

func (*CurrentModule) WithGraphQLQuery

func (r *CurrentModule) WithGraphQLQuery(q *querybuilder.Selection) *CurrentModule

func (*CurrentModule) Workdir

func (r *CurrentModule) Workdir(path string, opts ...CurrentModuleWorkdirOpts) *Directory

Load a directory from the module's scratch working directory, including any changes that may have been made to it during module function execution.

func (*CurrentModule) WorkdirFile

func (r *CurrentModule) WorkdirFile(path string) *File

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.

func (*CurrentModule) XXX_GraphQLID

func (r *CurrentModule) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*CurrentModule) XXX_GraphQLIDType

func (r *CurrentModule) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*CurrentModule) XXX_GraphQLType

func (r *CurrentModule) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type CurrentModuleGeneratorsOpts

type CurrentModuleGeneratorsOpts struct {
	// Only include generators matching the specified patterns
	Include []string
}

CurrentModuleGeneratorsOpts contains options for CurrentModule.Generators

type CurrentModuleID

type CurrentModuleID string

A unique identifier for an object.

type CurrentModuleWorkdirOpts

type CurrentModuleWorkdirOpts struct {
	// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
	Exclude []string
	// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
	Include []string
	// Apply .gitignore filter rules inside the directory
	Gitignore bool
}

CurrentModuleWorkdirOpts contains options for CurrentModule.Workdir

type CurrentTypeDefsOpts

type CurrentTypeDefsOpts struct {
	// Return the full referenced typedef closure instead of only top-level served typedefs.
	ReturnAllTypes bool
	// Strip core API functions from the Query type, leaving only module-sourced functions (constructors, entrypoint proxies, etc.).
	//
	// Core types (Container, Directory, etc.) are kept so return types and method chaining still work.
	HideCore bool
}

CurrentTypeDefsOpts contains options for Query.CurrentTypeDefs

type DaggerObject

type DaggerObject interface {
	querybuilder.GraphQLMarshaller
	ID(ctx context.Context) (ID, error)
}

type DiffStat

type DiffStat struct {
	// contains filtered or unexported fields
}

func (*DiffStat) AddedLines

func (r *DiffStat) AddedLines(ctx context.Context) (int, error)

Number of added lines for this path.

func (*DiffStat) AsNode

func (r *DiffStat) AsNode() Node

AsNode returns this DiffStat as a Node. This is a local type conversion — no GraphQL call.

func (*DiffStat) ID

func (r *DiffStat) ID(ctx context.Context) (ID, error)

A unique identifier for this DiffStat.

func (*DiffStat) Kind

func (r *DiffStat) Kind(ctx context.Context) (DiffStatKind, error)

Type of change.

func (*DiffStat) MarshalJSON

func (r *DiffStat) MarshalJSON() ([]byte, error)

func (*DiffStat) OldPath

func (r *DiffStat) OldPath(ctx context.Context) (string, error)

Previous path of the file, set only for renames.

func (*DiffStat) Path

func (r *DiffStat) Path(ctx context.Context) (string, error)

Path of the changed file or directory.

func (*DiffStat) RemovedLines

func (r *DiffStat) RemovedLines(ctx context.Context) (int, error)

Number of removed lines for this path.

func (*DiffStat) WithGraphQLQuery

func (r *DiffStat) WithGraphQLQuery(q *querybuilder.Selection) *DiffStat

func (*DiffStat) XXX_GraphQLID

func (r *DiffStat) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*DiffStat) XXX_GraphQLIDType

func (r *DiffStat) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*DiffStat) XXX_GraphQLType

func (r *DiffStat) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type DiffStatID

type DiffStatID string

A unique identifier for an object.

type DiffStatKind

type DiffStatKind string

The type of change for a diff stat entry.

const (
	// A file or directory was added.
	DiffStatKindAdded DiffStatKind = "ADDED"

	// A file was modified.
	DiffStatKindModified DiffStatKind = "MODIFIED"

	// A file or directory was removed.
	DiffStatKindRemoved DiffStatKind = "REMOVED"

	// A file was renamed.
	DiffStatKindRenamed DiffStatKind = "RENAMED"
)

func (DiffStatKind) IsEnum

func (DiffStatKind) IsEnum()

func (*DiffStatKind) MarshalJSON

func (v *DiffStatKind) MarshalJSON() ([]byte, error)

func (DiffStatKind) Name

func (v DiffStatKind) Name() string

func (*DiffStatKind) UnmarshalJSON

func (v *DiffStatKind) UnmarshalJSON(dt []byte) error

func (DiffStatKind) Value

func (v DiffStatKind) Value() string

type Directory

type Directory struct {
	// contains filtered or unexported fields
}

A directory.

func (*Directory) AsExportable

func (r *Directory) AsExportable() Exportable

AsExportable returns this Directory as a Exportable. This is a local type conversion — no GraphQL call.

func (*Directory) AsGit

func (r *Directory) AsGit() *GitRepository

Converts this directory to a local git repository

func (*Directory) AsModule

func (r *Directory) AsModule(opts ...DirectoryAsModuleOpts) *Module

Load the directory as a Dagger module source

func (*Directory) AsModuleSource

func (r *Directory) AsModuleSource(opts ...DirectoryAsModuleSourceOpts) *ModuleSource

Load the directory as a Dagger module source

func (*Directory) AsNode

func (r *Directory) AsNode() Node

AsNode returns this Directory as a Node. This is a local type conversion — no GraphQL call.

func (*Directory) AsSyncer

func (r *Directory) AsSyncer() Syncer

AsSyncer returns this Directory as a Syncer. This is a local type conversion — no GraphQL call.

func (*Directory) Changes

func (r *Directory) Changes(from *Directory) *Changeset

Return the difference between this directory and another directory, typically an older snapshot.

The difference is encoded as a changeset, which also tracks removed files, and can be applied to other directories.

func (*Directory) Chown

func (r *Directory) Chown(path string, owner string) *Directory

Change the owner of the directory contents recursively.

func (*Directory) Diff

func (r *Directory) Diff(other *Directory) *Directory

Return the difference between this directory and an another directory. The difference is encoded as a directory.

func (*Directory) Digest

func (r *Directory) Digest(ctx context.Context) (string, error)

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.

func (*Directory) Directory

func (r *Directory) Directory(path string) *Directory

Retrieves a directory at the given path.

func (*Directory) DockerBuild

func (r *Directory) DockerBuild(opts ...DirectoryDockerBuildOpts) *Container

Use Dockerfile compatibility to build a container from this directory. Only use this function for Dockerfile compatibility. Otherwise use the native Container type directly, it is feature-complete and supports all Dockerfile features.

func (*Directory) Entries

func (r *Directory) Entries(ctx context.Context, opts ...DirectoryEntriesOpts) ([]string, error)

Returns a list of files and directories at the given path.

func (*Directory) Exists

func (r *Directory) Exists(ctx context.Context, path string, opts ...DirectoryExistsOpts) (bool, error)

check if a file or directory exists

func (*Directory) Export

func (r *Directory) Export(ctx context.Context, path string, opts ...DirectoryExportOpts) (string, error)

Writes the contents of the directory to a path on the host.

func (*Directory) File

func (r *Directory) File(path string) *File

Retrieve a file at the given path.

func (*Directory) Filter

func (r *Directory) Filter(opts ...DirectoryFilterOpts) *Directory

Return a snapshot with some paths included or excluded

func (*Directory) FindUp

func (r *Directory) FindUp(ctx context.Context, name string, start string) (string, error)

Search up the directory tree for a file or directory, and return its path. If no match, return null

func (*Directory) Glob

func (r *Directory) Glob(ctx context.Context, pattern string) ([]string, error)

Returns a list of files and directories that matche the given pattern.

func (*Directory) ID

func (r *Directory) ID(ctx context.Context) (ID, error)

A unique identifier for this Directory.

func (*Directory) MarshalJSON

func (r *Directory) MarshalJSON() ([]byte, error)

func (*Directory) Name

func (r *Directory) Name(ctx context.Context) (string, error)

Returns the name of the directory.

func (*Directory) Search

func (r *Directory) Search(ctx context.Context, pattern string, opts ...DirectorySearchOpts) ([]SearchResult, error)

Searches for content matching the given regular expression or literal string.

Uses Rust regex syntax; escape literal ., [, ], {, }, | with backslashes.

func (*Directory) Stat

func (r *Directory) Stat(path string, opts ...DirectoryStatOpts) *Stat

Return file status

func (*Directory) Sync

func (r *Directory) Sync(ctx context.Context) (*Directory, error)

Force evaluation in the engine.

func (*Directory) Terminal

func (r *Directory) Terminal(opts ...DirectoryTerminalOpts) *Directory

Opens an interactive terminal in new container with this directory mounted inside.

func (*Directory) With

With calls the provided function with current Directory.

This is useful for reusability and readability by not breaking the calling chain.

func (*Directory) WithChanges

func (r *Directory) WithChanges(changes *Changeset) *Directory

Return a directory with changes from another directory applied to it.

func (*Directory) WithDirectory

func (r *Directory) WithDirectory(path string, source *Directory, opts ...DirectoryWithDirectoryOpts) *Directory

Return a snapshot with a directory added

func (*Directory) WithError

func (r *Directory) WithError(err string) *Directory

Raise an error.

func (*Directory) WithFile

func (r *Directory) WithFile(path string, source *File, opts ...DirectoryWithFileOpts) *Directory

Retrieves this directory plus the contents of the given file copied to the given path.

func (*Directory) WithFiles

func (r *Directory) WithFiles(path string, sources []*File, opts ...DirectoryWithFilesOpts) *Directory

Retrieves this directory plus the contents of the given files copied to the given path.

func (*Directory) WithGraphQLQuery

func (r *Directory) WithGraphQLQuery(q *querybuilder.Selection) *Directory

func (*Directory) WithNewDirectory

func (r *Directory) WithNewDirectory(path string, opts ...DirectoryWithNewDirectoryOpts) *Directory

Retrieves this directory plus a new directory created at the given path.

func (*Directory) WithNewFile

func (r *Directory) WithNewFile(path string, contents string, opts ...DirectoryWithNewFileOpts) *Directory

Return a snapshot with a new file added

func (*Directory) WithPatch

func (r *Directory) WithPatch(patch string) *Directory

Retrieves this directory with the given Git-compatible patch applied.

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Directory) WithPatchFile

func (r *Directory) WithPatchFile(patch *File) *Directory

Retrieves this directory with the given Git-compatible patch file applied.

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (r *Directory) WithSymlink(target string, linkName string) *Directory

Return a snapshot with a symlink

func (*Directory) WithTimestamps

func (r *Directory) WithTimestamps(timestamp int) *Directory

Retrieves this directory with all file/dir timestamps set to the given time.

func (*Directory) WithoutDirectory

func (r *Directory) WithoutDirectory(path string) *Directory

Return a snapshot with a subdirectory removed

func (*Directory) WithoutFile

func (r *Directory) WithoutFile(path string) *Directory

Return a snapshot with a file removed

func (*Directory) WithoutFiles

func (r *Directory) WithoutFiles(paths []string) *Directory

Return a snapshot with files removed

func (*Directory) XXX_GraphQLID

func (r *Directory) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Directory) XXX_GraphQLIDType

func (r *Directory) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Directory) XXX_GraphQLType

func (r *Directory) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type DirectoryAsModuleOpts

type DirectoryAsModuleOpts struct {
	// An optional subpath of the directory which contains the module's configuration file.
	//
	// If not set, the module source code is loaded from the root of the directory.
	//
	// Default: "."
	SourceRootPath string
}

DirectoryAsModuleOpts contains options for Directory.AsModule

type DirectoryAsModuleSourceOpts

type DirectoryAsModuleSourceOpts struct {
	// An optional subpath of the directory which contains the module's configuration file.
	//
	// If not set, the module source code is loaded from the root of the directory.
	//
	// Default: "."
	SourceRootPath string
}

DirectoryAsModuleSourceOpts contains options for Directory.AsModuleSource

type DirectoryDockerBuildOpts

type DirectoryDockerBuildOpts struct {
	// Path to the Dockerfile to use (e.g., "frontend.Dockerfile").
	//
	// Default: "Dockerfile"
	Dockerfile string
	// The platform to build.
	Platform Platform
	// Build arguments to use in the build.
	BuildArgs []BuildArg
	// Target build stage to build.
	Target string
	// Secrets to pass to the build.
	//
	// They will be mounted at /run/secrets/[secret-name].
	Secrets []*Secret
	// If set, skip the automatic init process injected into containers created by RUN statements.
	//
	// This should only be used if the user requires that their exec processes be the pid 1 process in the container. Otherwise it may result in unexpected behavior.
	NoInit bool
	// A socket to use for SSH authentication during the build
	//
	// (e.g., for Dockerfile RUN --mount=type=ssh instructions).
	//
	// Typically obtained via host.unixSocket() pointing to the SSH_AUTH_SOCK.
	SSH *Socket
}

DirectoryDockerBuildOpts contains options for Directory.DockerBuild

type DirectoryEntriesOpts

type DirectoryEntriesOpts struct {
	// Location of the directory to look at (e.g., "/src").
	Path string
}

DirectoryEntriesOpts contains options for Directory.Entries

type DirectoryExistsOpts

type DirectoryExistsOpts struct {
	// If specified, also validate the type of file (e.g. "REGULAR_TYPE", "DIRECTORY_TYPE", or "SYMLINK_TYPE").
	ExpectedType ExistsType
	// If specified, do not follow symlinks.
	DoNotFollowSymlinks bool
}

DirectoryExistsOpts contains options for Directory.Exists

type DirectoryExportOpts

type DirectoryExportOpts struct {
	// If true, then the host directory will be wiped clean before exporting so that it exactly matches the directory being exported; this means it will delete any files on the host that aren't in the exported dir. If false (the default), the contents of the directory will be merged with any existing contents of the host directory, leaving any existing files on the host that aren't in the exported directory alone.
	Wipe bool
}

DirectoryExportOpts contains options for Directory.Export

type DirectoryFilterOpts

type DirectoryFilterOpts struct {
	// If set, paths matching one of these glob patterns is excluded from the new snapshot. Example: ["node_modules/", ".git*", ".env"]
	Exclude []string
	// If set, only paths matching one of these glob patterns is included in the new snapshot. Example: (e.g., ["app/", "package.*"]).
	Include []string
	// If set, apply .gitignore rules when filtering the directory.
	Gitignore bool
}

DirectoryFilterOpts contains options for Directory.Filter

type DirectoryID

type DirectoryID string

A unique identifier for an object.

type DirectorySearchOpts

type DirectorySearchOpts struct {
	// Directory or file paths to search
	Paths []string
	// Glob patterns to match (e.g., "*.md")
	Globs []string
	// Interpret the pattern as a literal string instead of a regular expression.
	Literal bool
	// Enable searching across multiple lines.
	Multiline bool
	// Allow the . pattern to match newlines in multiline mode.
	Dotall bool
	// Enable case-insensitive matching.
	Insensitive bool
	// Honor .gitignore, .ignore, and .rgignore files.
	SkipIgnored bool
	// Skip hidden files (files starting with .).
	SkipHidden bool
	// Only return matching files, not lines and content
	FilesOnly bool
	// Limit the number of results to return
	Limit int
}

DirectorySearchOpts contains options for Directory.Search

type DirectoryStatOpts

type DirectoryStatOpts struct {
	// If specified, do not follow symlinks.
	DoNotFollowSymlinks bool
}

DirectoryStatOpts contains options for Directory.Stat

type DirectoryTerminalOpts

type DirectoryTerminalOpts struct {
	// If set, override the default container used for the terminal.
	Container *Container
	// If set, override the container's default terminal command and invoke these command arguments instead.
	Cmd []string
	// Provides Dagger access to the executed command.
	ExperimentalPrivilegedNesting bool
	// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
	InsecureRootCapabilities bool
}

DirectoryTerminalOpts contains options for Directory.Terminal

type DirectoryWithDirectoryOpts

type DirectoryWithDirectoryOpts struct {
	// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
	Exclude []string
	// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
	Include []string
	// Apply .gitignore filter rules inside the directory
	Gitignore bool
	// A user:group to set for the copied directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
	// Permission given to the copied directory and contents (e.g., 0755).
	Permissions int
}

DirectoryWithDirectoryOpts contains options for Directory.WithDirectory

type DirectoryWithFileOpts

type DirectoryWithFileOpts struct {
	// Permission given to the copied file (e.g., 0600).
	Permissions int
	// A user:group to set for the copied directory and its contents.
	//
	// The user and group can either be an ID (1000:1000) or a name (foo:bar).
	//
	// If the group is omitted, it defaults to the same as the user.
	Owner string
}

DirectoryWithFileOpts contains options for Directory.WithFile

type DirectoryWithFilesOpts

type DirectoryWithFilesOpts struct {
	// Permission given to the copied files (e.g., 0600).
	Permissions int
}

DirectoryWithFilesOpts contains options for Directory.WithFiles

type DirectoryWithNewDirectoryOpts

type DirectoryWithNewDirectoryOpts struct {
	// Permission granted to the created directory (e.g., 0777).
	//
	// Default: 420
	Permissions int
}

DirectoryWithNewDirectoryOpts contains options for Directory.WithNewDirectory

type DirectoryWithNewFileOpts

type DirectoryWithNewFileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
}

DirectoryWithNewFileOpts contains options for Directory.WithNewFile

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

The Dagger engine configuration and state

func (*Engine) AsNode

func (r *Engine) AsNode() Node

AsNode returns this Engine as a Node. This is a local type conversion — no GraphQL call.

func (*Engine) Clients

func (r *Engine) Clients(ctx context.Context) ([]string, error)

The list of connected client IDs

func (*Engine) ID

func (r *Engine) ID(ctx context.Context) (ID, error)

A unique identifier for this Engine.

func (*Engine) LocalCache

func (r *Engine) LocalCache() *EngineCache

The local engine cache state tracked by dagql

func (*Engine) MarshalJSON

func (r *Engine) MarshalJSON() ([]byte, error)

func (*Engine) Name

func (r *Engine) Name(ctx context.Context) (string, error)

The name of the engine instance.

func (*Engine) WithGraphQLQuery

func (r *Engine) WithGraphQLQuery(q *querybuilder.Selection) *Engine

func (*Engine) XXX_GraphQLID

func (r *Engine) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Engine) XXX_GraphQLIDType

func (r *Engine) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Engine) XXX_GraphQLType

func (r *Engine) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EngineCache

type EngineCache struct {
	// contains filtered or unexported fields
}

A cache storage for the Dagger engine

func (*EngineCache) AsNode

func (r *EngineCache) AsNode() Node

AsNode returns this EngineCache as a Node. This is a local type conversion — no GraphQL call.

func (*EngineCache) EntrySet

The current set of entries in the cache

func (*EngineCache) ID

func (r *EngineCache) ID(ctx context.Context) (ID, error)

A unique identifier for this EngineCache.

func (*EngineCache) MarshalJSON

func (r *EngineCache) MarshalJSON() ([]byte, error)

func (*EngineCache) MaxUsedSpace

func (r *EngineCache) MaxUsedSpace(ctx context.Context) (int, error)

The maximum bytes to keep in the cache without pruning.

func (*EngineCache) MinFreeSpace

func (r *EngineCache) MinFreeSpace(ctx context.Context) (int, error)

The target amount of free disk space the garbage collector will attempt to leave.

func (*EngineCache) Prune

func (r *EngineCache) Prune(ctx context.Context, opts ...EngineCachePruneOpts) error

Prune the cache of releaseable entries

func (*EngineCache) ReservedSpace

func (r *EngineCache) ReservedSpace(ctx context.Context) (int, error)

The minimum amount of disk space this policy is guaranteed to retain.

func (*EngineCache) TargetSpace

func (r *EngineCache) TargetSpace(ctx context.Context) (int, error)

The target number of bytes to keep when pruning.

func (*EngineCache) WithGraphQLQuery

func (r *EngineCache) WithGraphQLQuery(q *querybuilder.Selection) *EngineCache

func (*EngineCache) XXX_GraphQLID

func (r *EngineCache) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EngineCache) XXX_GraphQLIDType

func (r *EngineCache) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EngineCache) XXX_GraphQLType

func (r *EngineCache) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EngineCacheEntry

type EngineCacheEntry struct {
	// contains filtered or unexported fields
}

An individual cache entry in a cache entry set

func (*EngineCacheEntry) ActivelyUsed

func (r *EngineCacheEntry) ActivelyUsed(ctx context.Context) (bool, error)

Whether the cache entry is actively being used.

func (*EngineCacheEntry) AsNode

func (r *EngineCacheEntry) AsNode() Node

AsNode returns this EngineCacheEntry as a Node. This is a local type conversion — no GraphQL call.

func (*EngineCacheEntry) CreatedTimeUnixNano

func (r *EngineCacheEntry) CreatedTimeUnixNano(ctx context.Context) (int, error)

The time the cache entry was created, in Unix nanoseconds.

func (*EngineCacheEntry) DagqlCall

func (r *EngineCacheEntry) DagqlCall(ctx context.Context) (string, error)

The DagQL call that produced this cache entry.

func (*EngineCacheEntry) Description

func (r *EngineCacheEntry) Description(ctx context.Context) (string, error)

The description of the cache entry.

func (*EngineCacheEntry) DiskSpaceBytes

func (r *EngineCacheEntry) DiskSpaceBytes(ctx context.Context) (int, error)

The disk space used by the cache entry.

func (*EngineCacheEntry) ID

func (r *EngineCacheEntry) ID(ctx context.Context) (ID, error)

A unique identifier for this EngineCacheEntry.

func (*EngineCacheEntry) MarshalJSON

func (r *EngineCacheEntry) MarshalJSON() ([]byte, error)

func (*EngineCacheEntry) MostRecentUseTimeUnixNano

func (r *EngineCacheEntry) MostRecentUseTimeUnixNano(ctx context.Context) (int, error)

The most recent time the cache entry was used, in Unix nanoseconds.

func (*EngineCacheEntry) RecordType

func (r *EngineCacheEntry) RecordType(ctx context.Context) (string, error)

The type of the cache record (e.g. regular, internal, frontend, source.local, source.git.checkout, exec.cachemount).

func (*EngineCacheEntry) RecordTypes

func (r *EngineCacheEntry) RecordTypes(ctx context.Context) ([]string, error)

The storage record types represented by this cache entry.

func (*EngineCacheEntry) WithGraphQLQuery

func (r *EngineCacheEntry) WithGraphQLQuery(q *querybuilder.Selection) *EngineCacheEntry

func (*EngineCacheEntry) XXX_GraphQLID

func (r *EngineCacheEntry) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EngineCacheEntry) XXX_GraphQLIDType

func (r *EngineCacheEntry) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EngineCacheEntry) XXX_GraphQLType

func (r *EngineCacheEntry) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EngineCacheEntryID

type EngineCacheEntryID string

A unique identifier for an object.

type EngineCacheEntrySet

type EngineCacheEntrySet struct {
	// contains filtered or unexported fields
}

A set of cache entries returned by a query to a cache

func (*EngineCacheEntrySet) AsNode

func (r *EngineCacheEntrySet) AsNode() Node

AsNode returns this EngineCacheEntrySet as a Node. This is a local type conversion — no GraphQL call.

func (*EngineCacheEntrySet) DiskSpaceBytes

func (r *EngineCacheEntrySet) DiskSpaceBytes(ctx context.Context) (int, error)

The total disk space used by the cache entries in this set.

func (*EngineCacheEntrySet) Entries

The list of individual cache entries in the set

func (*EngineCacheEntrySet) EntryCount

func (r *EngineCacheEntrySet) EntryCount(ctx context.Context) (int, error)

The number of cache entries in this set.

func (*EngineCacheEntrySet) ID

func (r *EngineCacheEntrySet) ID(ctx context.Context) (ID, error)

A unique identifier for this EngineCacheEntrySet.

func (*EngineCacheEntrySet) MarshalJSON

func (r *EngineCacheEntrySet) MarshalJSON() ([]byte, error)

func (*EngineCacheEntrySet) WithGraphQLQuery

func (*EngineCacheEntrySet) XXX_GraphQLID

func (r *EngineCacheEntrySet) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EngineCacheEntrySet) XXX_GraphQLIDType

func (r *EngineCacheEntrySet) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EngineCacheEntrySet) XXX_GraphQLType

func (r *EngineCacheEntrySet) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EngineCacheEntrySetID

type EngineCacheEntrySetID string

A unique identifier for an object.

type EngineCacheEntrySetOpts

type EngineCacheEntrySetOpts struct {
	Key string
}

EngineCacheEntrySetOpts contains options for EngineCache.EntrySet

type EngineCacheID

type EngineCacheID string

A unique identifier for an object.

type EngineCachePruneOpts

type EngineCachePruneOpts struct {
	// Use the engine-wide default pruning policy if true, otherwise prune the whole cache of any releasable entries.
	UseDefaultPolicy bool
	// Override the maximum disk space to keep before pruning (e.g. "200GB" or "80%").
	MaxUsedSpace string
	// Override the minimum disk space to retain during pruning (e.g. "500GB" or "10%").
	ReservedSpace string
	// Override the minimum free disk space target during pruning (e.g. "20GB" or "20%").
	MinFreeSpace string
	// Override the target disk space to keep after pruning (e.g. "200GB" or "50%").
	TargetSpace string
}

EngineCachePruneOpts contains options for EngineCache.Prune

type EngineID

type EngineID string

A unique identifier for an object.

type EnumTypeDef

type EnumTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a custom enum defined in a Module.

func (*EnumTypeDef) AsNode

func (r *EnumTypeDef) AsNode() Node

AsNode returns this EnumTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*EnumTypeDef) Description

func (r *EnumTypeDef) Description(ctx context.Context) (string, error)

A doc string for the enum, if any.

func (*EnumTypeDef) ID

func (r *EnumTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this EnumTypeDef.

func (*EnumTypeDef) MarshalJSON

func (r *EnumTypeDef) MarshalJSON() ([]byte, error)

func (*EnumTypeDef) Members

func (r *EnumTypeDef) Members(ctx context.Context) ([]EnumValueTypeDef, error)

The members of the enum.

func (*EnumTypeDef) Name

func (r *EnumTypeDef) Name(ctx context.Context) (string, error)

The name of the enum.

func (*EnumTypeDef) SourceMap

func (r *EnumTypeDef) SourceMap() *SourceMap

The location of this enum declaration.

func (*EnumTypeDef) SourceModuleName

func (r *EnumTypeDef) SourceModuleName(ctx context.Context) (string, error)

If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.

func (*EnumTypeDef) Values deprecated

func (r *EnumTypeDef) Values(ctx context.Context) ([]EnumValueTypeDef, error)

The members of the enum.

Deprecated: use members instead

func (*EnumTypeDef) WithGraphQLQuery

func (r *EnumTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *EnumTypeDef

func (*EnumTypeDef) XXX_GraphQLID

func (r *EnumTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EnumTypeDef) XXX_GraphQLIDType

func (r *EnumTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EnumTypeDef) XXX_GraphQLType

func (r *EnumTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EnumTypeDefID

type EnumTypeDefID string

A unique identifier for an object.

type EnumValueTypeDef

type EnumValueTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a value in a custom enum defined in a Module.

func (*EnumValueTypeDef) AsNode

func (r *EnumValueTypeDef) AsNode() Node

AsNode returns this EnumValueTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*EnumValueTypeDef) Deprecated

func (r *EnumValueTypeDef) Deprecated(ctx context.Context) (string, error)

The reason this enum member is deprecated, if any.

func (*EnumValueTypeDef) Description

func (r *EnumValueTypeDef) Description(ctx context.Context) (string, error)

A doc string for the enum member, if any.

func (*EnumValueTypeDef) ID

func (r *EnumValueTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this EnumValueTypeDef.

func (*EnumValueTypeDef) MarshalJSON

func (r *EnumValueTypeDef) MarshalJSON() ([]byte, error)

func (*EnumValueTypeDef) Name

func (r *EnumValueTypeDef) Name(ctx context.Context) (string, error)

The name of the enum member.

func (*EnumValueTypeDef) SourceMap

func (r *EnumValueTypeDef) SourceMap() *SourceMap

The location of this enum member declaration.

func (*EnumValueTypeDef) Value

func (r *EnumValueTypeDef) Value(ctx context.Context) (string, error)

The value of the enum member

func (*EnumValueTypeDef) WithGraphQLQuery

func (r *EnumValueTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *EnumValueTypeDef

func (*EnumValueTypeDef) XXX_GraphQLID

func (r *EnumValueTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EnumValueTypeDef) XXX_GraphQLIDType

func (r *EnumValueTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EnumValueTypeDef) XXX_GraphQLType

func (r *EnumValueTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EnumValueTypeDefID

type EnumValueTypeDefID string

A unique identifier for an object.

type Env

type Env struct {
	// contains filtered or unexported fields
}

func (*Env) AsNode

func (r *Env) AsNode() Node

AsNode returns this Env as a Node. This is a local type conversion — no GraphQL call.

func (*Env) Check

func (r *Env) Check(name string) *Check

Return the check with the given name from the installed modules. Must match exactly one check.

Experimental: Checks API is highly experimental and may be removed or replaced entirely.

func (*Env) Checks

func (r *Env) Checks(opts ...EnvChecksOpts) *CheckGroup

Return all checks defined by the installed modules

Experimental: Checks API is highly experimental and may be removed or replaced entirely.

func (*Env) ID

func (r *Env) ID(ctx context.Context) (ID, error)

A unique identifier for this Env.

func (*Env) Input

func (r *Env) Input(name string) *Binding

Retrieves an input binding by name

func (*Env) Inputs

func (r *Env) Inputs(ctx context.Context) ([]Binding, error)

Returns all input bindings provided to the environment

func (*Env) MarshalJSON

func (r *Env) MarshalJSON() ([]byte, error)

func (*Env) Output

func (r *Env) Output(name string) *Binding

Retrieves an output binding by name

func (*Env) Outputs

func (r *Env) Outputs(ctx context.Context) ([]Binding, error)

Returns all declared output bindings for the environment

func (*Env) Services

func (r *Env) Services(opts ...EnvServicesOpts) *UpGroup

Return all services defined by the installed modules

Experimental: Services API is highly experimental and may be removed or replaced entirely.

func (*Env) With

func (r *Env) With(f WithEnvFunc) *Env

With calls the provided function with current Env.

This is useful for reusability and readability by not breaking the calling chain.

func (*Env) WithAddressInput

func (r *Env) WithAddressInput(name string, value *Address, description string) *Env

Create or update a binding of type Address in the environment

func (*Env) WithAddressOutput

func (r *Env) WithAddressOutput(name string, description string) *Env

Declare a desired Address output to be assigned in the environment

func (*Env) WithArchInput

func (r *Env) WithArchInput(name string, value *Arch, description string) *Env

Create or update a binding of type Arch in the environment

func (*Env) WithArchOutput

func (r *Env) WithArchOutput(name string, description string) *Env

Declare a desired Arch output to be assigned in the environment

func (*Env) WithArchiveInput

func (r *Env) WithArchiveInput(name string, value *Archive, description string) *Env

Create or update a binding of type Archive in the environment

func (*Env) WithArchiveOutput

func (r *Env) WithArchiveOutput(name string, description string) *Env

Declare a desired Archive output to be assigned in the environment

func (*Env) WithCacheVolumeInput

func (r *Env) WithCacheVolumeInput(name string, value *CacheVolume, description string) *Env

Create or update a binding of type CacheVolume in the environment

func (*Env) WithCacheVolumeOutput

func (r *Env) WithCacheVolumeOutput(name string, description string) *Env

Declare a desired CacheVolume output to be assigned in the environment

func (*Env) WithChangesetInput

func (r *Env) WithChangesetInput(name string, value *Changeset, description string) *Env

Create or update a binding of type Changeset in the environment

func (*Env) WithChangesetOutput

func (r *Env) WithChangesetOutput(name string, description string) *Env

Declare a desired Changeset output to be assigned in the environment

func (*Env) WithCheckGroupInput

func (r *Env) WithCheckGroupInput(name string, value *CheckGroup, description string) *Env

Create or update a binding of type CheckGroup in the environment

func (*Env) WithCheckGroupOutput

func (r *Env) WithCheckGroupOutput(name string, description string) *Env

Declare a desired CheckGroup output to be assigned in the environment

func (*Env) WithCheckInput

func (r *Env) WithCheckInput(name string, value *Check, description string) *Env

Create or update a binding of type Check in the environment

func (*Env) WithCheckOutput

func (r *Env) WithCheckOutput(name string, description string) *Env

Declare a desired Check output to be assigned in the environment

func (*Env) WithCloudInput

func (r *Env) WithCloudInput(name string, value *Cloud, description string) *Env

Create or update a binding of type Cloud in the environment

func (*Env) WithCloudOutput

func (r *Env) WithCloudOutput(name string, description string) *Env

Declare a desired Cloud output to be assigned in the environment

func (*Env) WithContainerInput

func (r *Env) WithContainerInput(name string, value *Container, description string) *Env

Create or update a binding of type Container in the environment

func (*Env) WithContainerOutput

func (r *Env) WithContainerOutput(name string, description string) *Env

Declare a desired Container output to be assigned in the environment

func (*Env) WithCurrentModule

func (r *Env) WithCurrentModule() *Env

Installs the current module into the environment, exposing its functions to the model

Contextual path arguments will be populated using the environment's workspace.

func (*Env) WithDiffStatInput

func (r *Env) WithDiffStatInput(name string, value *DiffStat, description string) *Env

Create or update a binding of type DiffStat in the environment

func (*Env) WithDiffStatOutput

func (r *Env) WithDiffStatOutput(name string, description string) *Env

Declare a desired DiffStat output to be assigned in the environment

func (*Env) WithDirectoryInput

func (r *Env) WithDirectoryInput(name string, value *Directory, description string) *Env

Create or update a binding of type Directory in the environment

func (*Env) WithDirectoryOutput

func (r *Env) WithDirectoryOutput(name string, description string) *Env

Declare a desired Directory output to be assigned in the environment

func (*Env) WithEnvFileInput

func (r *Env) WithEnvFileInput(name string, value *EnvFile, description string) *Env

Create or update a binding of type EnvFile in the environment

func (*Env) WithEnvFileOutput

func (r *Env) WithEnvFileOutput(name string, description string) *Env

Declare a desired EnvFile output to be assigned in the environment

func (*Env) WithEnvInput

func (r *Env) WithEnvInput(name string, value *Env, description string) *Env

Create or update a binding of type Env in the environment

func (*Env) WithEnvOutput

func (r *Env) WithEnvOutput(name string, description string) *Env

Declare a desired Env output to be assigned in the environment

func (*Env) WithFileInput

func (r *Env) WithFileInput(name string, value *File, description string) *Env

Create or update a binding of type File in the environment

func (*Env) WithFileOutput

func (r *Env) WithFileOutput(name string, description string) *Env

Declare a desired File output to be assigned in the environment

func (*Env) WithGeneratorGroupInput

func (r *Env) WithGeneratorGroupInput(name string, value *GeneratorGroup, description string) *Env

Create or update a binding of type GeneratorGroup in the environment

func (*Env) WithGeneratorGroupOutput

func (r *Env) WithGeneratorGroupOutput(name string, description string) *Env

Declare a desired GeneratorGroup output to be assigned in the environment

func (*Env) WithGeneratorInput

func (r *Env) WithGeneratorInput(name string, value *Generator, description string) *Env

Create or update a binding of type Generator in the environment

func (*Env) WithGeneratorOutput

func (r *Env) WithGeneratorOutput(name string, description string) *Env

Declare a desired Generator output to be assigned in the environment

func (*Env) WithGitRefInput

func (r *Env) WithGitRefInput(name string, value *GitRef, description string) *Env

Create or update a binding of type GitRef in the environment

func (*Env) WithGitRefOutput

func (r *Env) WithGitRefOutput(name string, description string) *Env

Declare a desired GitRef output to be assigned in the environment

func (*Env) WithGitRepositoryInput

func (r *Env) WithGitRepositoryInput(name string, value *GitRepository, description string) *Env

Create or update a binding of type GitRepository in the environment

func (*Env) WithGitRepositoryOutput

func (r *Env) WithGitRepositoryOutput(name string, description string) *Env

Declare a desired GitRepository output to be assigned in the environment

func (*Env) WithGoInput

func (r *Env) WithGoInput(name string, value *Go, description string) *Env

Create or update a binding of type Go in the environment

func (*Env) WithGoOutput

func (r *Env) WithGoOutput(name string, description string) *Env

Declare a desired Go output to be assigned in the environment

func (*Env) WithGraphQLQuery

func (r *Env) WithGraphQLQuery(q *querybuilder.Selection) *Env

func (*Env) WithHTTPStateInput

func (r *Env) WithHTTPStateInput(name string, value *HTTPState, description string) *Env

Create or update a binding of type HTTPState in the environment

func (*Env) WithHTTPStateOutput

func (r *Env) WithHTTPStateOutput(name string, description string) *Env

Declare a desired HTTPState output to be assigned in the environment

func (*Env) WithJSONValueInput

func (r *Env) WithJSONValueInput(name string, value *JSONValue, description string) *Env

Create or update a binding of type JSONValue in the environment

func (*Env) WithJSONValueOutput

func (r *Env) WithJSONValueOutput(name string, description string) *Env

Declare a desired JSONValue output to be assigned in the environment

func (*Env) WithMainModule

func (r *Env) WithMainModule(module *Module) *Env

Sets the main module for this environment (the project being worked on)

Contextual path arguments will be populated using the environment's workspace.

func (*Env) WithMiseInput

func (r *Env) WithMiseInput(name string, value *Mise, description string) *Env

Create or update a binding of type Mise in the environment

func (*Env) WithMiseOutput

func (r *Env) WithMiseOutput(name string, description string) *Env

Declare a desired Mise output to be assigned in the environment

func (*Env) WithModule deprecated

func (r *Env) WithModule(module *Module) *Env

Installs a module into the environment, exposing its functions to the model

Contextual path arguments will be populated using the environment's workspace.

Deprecated: Use withMainModule instead

func (*Env) WithModuleConfigClientInput

func (r *Env) WithModuleConfigClientInput(name string, value *ModuleConfigClient, description string) *Env

Create or update a binding of type ModuleConfigClient in the environment

func (*Env) WithModuleConfigClientOutput

func (r *Env) WithModuleConfigClientOutput(name string, description string) *Env

Declare a desired ModuleConfigClient output to be assigned in the environment

func (*Env) WithModuleInput

func (r *Env) WithModuleInput(name string, value *Module, description string) *Env

Create or update a binding of type Module in the environment

func (*Env) WithModuleOutput

func (r *Env) WithModuleOutput(name string, description string) *Env

Declare a desired Module output to be assigned in the environment

func (*Env) WithModuleSourceInput

func (r *Env) WithModuleSourceInput(name string, value *ModuleSource, description string) *Env

Create or update a binding of type ModuleSource in the environment

func (*Env) WithModuleSourceOutput

func (r *Env) WithModuleSourceOutput(name string, description string) *Env

Declare a desired ModuleSource output to be assigned in the environment

func (*Env) WithSearchResultInput

func (r *Env) WithSearchResultInput(name string, value *SearchResult, description string) *Env

Create or update a binding of type SearchResult in the environment

func (*Env) WithSearchResultOutput

func (r *Env) WithSearchResultOutput(name string, description string) *Env

Declare a desired SearchResult output to be assigned in the environment

func (*Env) WithSearchSubmatchInput

func (r *Env) WithSearchSubmatchInput(name string, value *SearchSubmatch, description string) *Env

Create or update a binding of type SearchSubmatch in the environment

func (*Env) WithSearchSubmatchOutput

func (r *Env) WithSearchSubmatchOutput(name string, description string) *Env

Declare a desired SearchSubmatch output to be assigned in the environment

func (*Env) WithSecretInput

func (r *Env) WithSecretInput(name string, value *Secret, description string) *Env

Create or update a binding of type Secret in the environment

func (*Env) WithSecretOutput

func (r *Env) WithSecretOutput(name string, description string) *Env

Declare a desired Secret output to be assigned in the environment

func (*Env) WithServiceInput

func (r *Env) WithServiceInput(name string, value *Service, description string) *Env

Create or update a binding of type Service in the environment

func (*Env) WithServiceOutput

func (r *Env) WithServiceOutput(name string, description string) *Env

Declare a desired Service output to be assigned in the environment

func (*Env) WithSindriDevInput

func (r *Env) WithSindriDevInput(name string, value *SindriDev, description string) *Env

Create or update a binding of type SindriDev in the environment

func (*Env) WithSindriDevOutput

func (r *Env) WithSindriDevOutput(name string, description string) *Env

Declare a desired SindriDev output to be assigned in the environment

func (*Env) WithSindriInput

func (r *Env) WithSindriInput(name string, value *Sindri, description string) *Env

Create or update a binding of type Sindri in the environment

func (*Env) WithSindriOutput

func (r *Env) WithSindriOutput(name string, description string) *Env

Declare a desired Sindri output to be assigned in the environment

func (*Env) WithSocketInput

func (r *Env) WithSocketInput(name string, value *Socket, description string) *Env

Create or update a binding of type Socket in the environment

func (*Env) WithSocketOutput

func (r *Env) WithSocketOutput(name string, description string) *Env

Declare a desired Socket output to be assigned in the environment

func (*Env) WithStatInput

func (r *Env) WithStatInput(name string, value *Stat, description string) *Env

Create or update a binding of type Stat in the environment

func (*Env) WithStatOutput

func (r *Env) WithStatOutput(name string, description string) *Env

Declare a desired Stat output to be assigned in the environment

func (*Env) WithStringInput

func (r *Env) WithStringInput(name string, value string, description string) *Env

Provides a string input binding to the environment

func (*Env) WithStringOutput

func (r *Env) WithStringOutput(name string, description string) *Env

Declares a desired string output binding

func (*Env) WithUpGroupInput

func (r *Env) WithUpGroupInput(name string, value *UpGroup, description string) *Env

Create or update a binding of type UpGroup in the environment

func (*Env) WithUpGroupOutput

func (r *Env) WithUpGroupOutput(name string, description string) *Env

Declare a desired UpGroup output to be assigned in the environment

func (*Env) WithUpInput

func (r *Env) WithUpInput(name string, value *Up, description string) *Env

Create or update a binding of type Up in the environment

func (*Env) WithUpOutput

func (r *Env) WithUpOutput(name string, description string) *Env

Declare a desired Up output to be assigned in the environment

func (*Env) WithWolfiInput

func (r *Env) WithWolfiInput(name string, value *Wolfi, description string) *Env

Create or update a binding of type Wolfi in the environment

func (*Env) WithWolfiOutput

func (r *Env) WithWolfiOutput(name string, description string) *Env

Declare a desired Wolfi output to be assigned in the environment

func (*Env) WithWorkspace

func (r *Env) WithWorkspace(workspace *Directory) *Env

Returns a new environment with the provided workspace

func (*Env) WithWorkspaceInput

func (r *Env) WithWorkspaceInput(name string, value *Workspace, description string) *Env

Create or update a binding of type Workspace in the environment

func (*Env) WithWorkspaceOutput

func (r *Env) WithWorkspaceOutput(name string, description string) *Env

Declare a desired Workspace output to be assigned in the environment

func (*Env) WithoutOutputs

func (r *Env) WithoutOutputs() *Env

Returns a new environment without any outputs

func (*Env) Workspace

func (r *Env) Workspace() *Directory

func (*Env) XXX_GraphQLID

func (r *Env) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Env) XXX_GraphQLIDType

func (r *Env) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Env) XXX_GraphQLType

func (r *Env) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EnvChecksOpts

type EnvChecksOpts struct {
	// Only include checks matching the specified patterns
	Include []string
	// When true, only return annotated check functions; exclude generate-as-checks
	NoGenerate bool
}

EnvChecksOpts contains options for Env.Checks

type EnvFile

type EnvFile struct {
	// contains filtered or unexported fields
}

A collection of environment variables.

func (*EnvFile) AsFile

func (r *EnvFile) AsFile() *File

Return as a file

func (*EnvFile) AsNode

func (r *EnvFile) AsNode() Node

AsNode returns this EnvFile as a Node. This is a local type conversion — no GraphQL call.

func (*EnvFile) Exists

func (r *EnvFile) Exists(ctx context.Context, name string) (bool, error)

Check if a variable exists

func (*EnvFile) Get

func (r *EnvFile) Get(ctx context.Context, name string, opts ...EnvFileGetOpts) (string, error)

Lookup a variable (last occurrence wins) and return its value, or an empty string

func (*EnvFile) ID

func (r *EnvFile) ID(ctx context.Context) (ID, error)

A unique identifier for this EnvFile.

func (*EnvFile) MarshalJSON

func (r *EnvFile) MarshalJSON() ([]byte, error)

func (*EnvFile) Namespace

func (r *EnvFile) Namespace(prefix string) *EnvFile

Filters variables by prefix and removes the pref from keys. Variables without the prefix are excluded. For example, with the prefix "MY_APP_" and variables: MY_APP_TOKEN=topsecret MY_APP_NAME=hello FOO=bar the resulting environment will contain: TOKEN=topsecret NAME=hello

func (*EnvFile) Variables

func (r *EnvFile) Variables(ctx context.Context, opts ...EnvFileVariablesOpts) ([]EnvVariable, error)

Return all variables

func (*EnvFile) With

func (r *EnvFile) With(f WithEnvFileFunc) *EnvFile

With calls the provided function with current EnvFile.

This is useful for reusability and readability by not breaking the calling chain.

func (*EnvFile) WithGraphQLQuery

func (r *EnvFile) WithGraphQLQuery(q *querybuilder.Selection) *EnvFile

func (*EnvFile) WithVariable

func (r *EnvFile) WithVariable(name string, value string) *EnvFile

Add a variable

func (*EnvFile) WithoutVariable

func (r *EnvFile) WithoutVariable(name string) *EnvFile

Remove all occurrences of the named variable

func (*EnvFile) XXX_GraphQLID

func (r *EnvFile) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EnvFile) XXX_GraphQLIDType

func (r *EnvFile) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EnvFile) XXX_GraphQLType

func (r *EnvFile) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EnvFileGetOpts

type EnvFileGetOpts struct {
	// Return the value exactly as written to the file. No quote removal or variable expansion
	Raw bool
}

EnvFileGetOpts contains options for EnvFile.Get

type EnvFileID

type EnvFileID string

A unique identifier for an object.

type EnvFileOpts

type EnvFileOpts struct {
	// Replace "${VAR}" or "$VAR" with the value of other vars
	// Deprecated: Variable expansion is now enabled by default
	Expand bool
}

EnvFileOpts contains options for Query.EnvFile

type EnvFileVariablesOpts

type EnvFileVariablesOpts struct {
	// Return values exactly as written to the file. No quote removal or variable expansion
	Raw bool
}

EnvFileVariablesOpts contains options for EnvFile.Variables

type EnvID

type EnvID string

A unique identifier for an object.

type EnvOpts

type EnvOpts struct {
	// Give the environment the same privileges as the caller: core API including host access, current module, and dependencies
	Privileged bool
	// Allow new outputs to be declared and saved in the environment
	Writable bool
}

EnvOpts contains options for Query.Env

type EnvServicesOpts

type EnvServicesOpts struct {
	// Only include services matching the specified patterns
	Include []string
}

EnvServicesOpts contains options for Env.Services

type EnvVariable

type EnvVariable struct {
	// contains filtered or unexported fields
}

An environment variable name and value.

func (*EnvVariable) AsNode

func (r *EnvVariable) AsNode() Node

AsNode returns this EnvVariable as a Node. This is a local type conversion — no GraphQL call.

func (*EnvVariable) ID

func (r *EnvVariable) ID(ctx context.Context) (ID, error)

A unique identifier for this EnvVariable.

func (*EnvVariable) MarshalJSON

func (r *EnvVariable) MarshalJSON() ([]byte, error)

func (*EnvVariable) Name

func (r *EnvVariable) Name(ctx context.Context) (string, error)

The environment variable name.

func (*EnvVariable) Value

func (r *EnvVariable) Value(ctx context.Context) (string, error)

The environment variable value.

func (*EnvVariable) WithGraphQLQuery

func (r *EnvVariable) WithGraphQLQuery(q *querybuilder.Selection) *EnvVariable

func (*EnvVariable) XXX_GraphQLID

func (r *EnvVariable) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*EnvVariable) XXX_GraphQLIDType

func (r *EnvVariable) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*EnvVariable) XXX_GraphQLType

func (r *EnvVariable) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type EnvVariableID

type EnvVariableID string

A unique identifier for an object.

type Error

type Error struct {
	// contains filtered or unexported fields
}

func (*Error) AsNode

func (r *Error) AsNode() Node

AsNode returns this Error as a Node. This is a local type conversion — no GraphQL call.

func (*Error) ID

func (r *Error) ID(ctx context.Context) (ID, error)

A unique identifier for this Error.

func (*Error) MarshalJSON

func (r *Error) MarshalJSON() ([]byte, error)

func (*Error) Message

func (r *Error) Message(ctx context.Context) (string, error)

A description of the error.

func (*Error) Values

func (r *Error) Values(ctx context.Context) ([]ErrorValue, error)

The extensions of the error.

func (*Error) With

func (r *Error) With(f WithErrorFunc) *Error

With calls the provided function with current Error.

This is useful for reusability and readability by not breaking the calling chain.

func (*Error) WithGraphQLQuery

func (r *Error) WithGraphQLQuery(q *querybuilder.Selection) *Error

func (*Error) WithValue

func (r *Error) WithValue(name string, value JSON) *Error

Add a value to the error.

func (*Error) XXX_GraphQLID

func (r *Error) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Error) XXX_GraphQLIDType

func (r *Error) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Error) XXX_GraphQLType

func (r *Error) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ErrorID

type ErrorID string

A unique identifier for an object.

type ErrorValue

type ErrorValue struct {
	// contains filtered or unexported fields
}

func (*ErrorValue) AsNode

func (r *ErrorValue) AsNode() Node

AsNode returns this ErrorValue as a Node. This is a local type conversion — no GraphQL call.

func (*ErrorValue) ID

func (r *ErrorValue) ID(ctx context.Context) (ID, error)

A unique identifier for this ErrorValue.

func (*ErrorValue) MarshalJSON

func (r *ErrorValue) MarshalJSON() ([]byte, error)

func (*ErrorValue) Name

func (r *ErrorValue) Name(ctx context.Context) (string, error)

The name of the value.

func (*ErrorValue) Value

func (r *ErrorValue) Value(ctx context.Context) (JSON, error)

The value.

func (*ErrorValue) WithGraphQLQuery

func (r *ErrorValue) WithGraphQLQuery(q *querybuilder.Selection) *ErrorValue

func (*ErrorValue) XXX_GraphQLID

func (r *ErrorValue) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ErrorValue) XXX_GraphQLIDType

func (r *ErrorValue) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ErrorValue) XXX_GraphQLType

func (r *ErrorValue) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ErrorValueID

type ErrorValueID string

A unique identifier for an object.

type ExecError

type ExecError struct {
	Cmd      []string
	ExitCode int
	Stdout   string
	Stderr   string
	// contains filtered or unexported fields
}

ExecError is an API error from an exec operation.

func (*ExecError) Error

func (e *ExecError) Error() string

func (*ExecError) Extensions

func (e *ExecError) Extensions() map[string]any

func (*ExecError) Message

func (e *ExecError) Message() string

func (*ExecError) Unwrap

func (e *ExecError) Unwrap() error

type ExistsType

type ExistsType string

File type.

const (
	// Tests path is a regular file
	ExistsTypeRegularType ExistsType = "REGULAR_TYPE"

	// Tests path is a directory
	ExistsTypeDirectoryType ExistsType = "DIRECTORY_TYPE"

	// Tests path is a symlink
	ExistsTypeSymlinkType ExistsType = "SYMLINK_TYPE"
)

func (ExistsType) IsEnum

func (ExistsType) IsEnum()

func (*ExistsType) MarshalJSON

func (v *ExistsType) MarshalJSON() ([]byte, error)

func (ExistsType) Name

func (v ExistsType) Name() string

func (*ExistsType) UnmarshalJSON

func (v *ExistsType) UnmarshalJSON(dt []byte) error

func (ExistsType) Value

func (v ExistsType) Value() string

type Exportable

type Exportable interface {
	DaggerObject

	Export(ctx context.Context, path string) (string, error)

	ID(ctx context.Context) (ID, error)

	// Concrete loads and returns the underlying concrete type of this
	// interface, which can then be used with a type switch.
	Concrete(ctx context.Context) (Node, error)
}

An object that can be exported to the host.

Calling export writes the object to a path on the host filesystem and returns the path that was written.

type ExportableClient

type ExportableClient struct {
	// contains filtered or unexported fields
}

ExportableClient is the query-builder for the Exportable interface.

func (*ExportableClient) Concrete

func (r *ExportableClient) Concrete(ctx context.Context) (Node, error)

Concrete loads and returns the underlying concrete type of this interface, which can then be used with a type switch.

func (*ExportableClient) Export

func (r *ExportableClient) Export(ctx context.Context, path string) (string, error)

func (*ExportableClient) ID

func (r *ExportableClient) ID(ctx context.Context) (ID, error)

func (*ExportableClient) MarshalJSON

func (r *ExportableClient) MarshalJSON() ([]byte, error)

func (*ExportableClient) WithGraphQLQuery

func (r *ExportableClient) WithGraphQLQuery(q *querybuilder.Selection) *ExportableClient

func (*ExportableClient) XXX_GraphQLID

func (r *ExportableClient) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ExportableClient) XXX_GraphQLIDType

func (r *ExportableClient) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ExportableClient) XXX_GraphQLType

func (r *ExportableClient) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ExportableID

type ExportableID string

A unique identifier for an object.

type FieldTypeDef

type FieldTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a field on a custom object defined in a Module.

A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).

func (*FieldTypeDef) AsNode

func (r *FieldTypeDef) AsNode() Node

AsNode returns this FieldTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*FieldTypeDef) Deprecated

func (r *FieldTypeDef) Deprecated(ctx context.Context) (string, error)

The reason this enum member is deprecated, if any.

func (*FieldTypeDef) Description

func (r *FieldTypeDef) Description(ctx context.Context) (string, error)

A doc string for the field, if any.

func (*FieldTypeDef) ID

func (r *FieldTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this FieldTypeDef.

func (*FieldTypeDef) MarshalJSON

func (r *FieldTypeDef) MarshalJSON() ([]byte, error)

func (*FieldTypeDef) Name

func (r *FieldTypeDef) Name(ctx context.Context) (string, error)

The name of the field in lowerCamelCase format.

func (*FieldTypeDef) SourceMap

func (r *FieldTypeDef) SourceMap() *SourceMap

The location of this field declaration.

func (*FieldTypeDef) TypeDef

func (r *FieldTypeDef) TypeDef() *TypeDef

The type of the field.

func (*FieldTypeDef) WithGraphQLQuery

func (r *FieldTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *FieldTypeDef

func (*FieldTypeDef) XXX_GraphQLID

func (r *FieldTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*FieldTypeDef) XXX_GraphQLIDType

func (r *FieldTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*FieldTypeDef) XXX_GraphQLType

func (r *FieldTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FieldTypeDefID

type FieldTypeDefID string

A unique identifier for an object.

type File

type File struct {
	// contains filtered or unexported fields
}

A file.

func (*File) AsEnvFile

func (r *File) AsEnvFile(opts ...FileAsEnvFileOpts) *EnvFile

Parse as an env file

func (*File) AsExportable

func (r *File) AsExportable() Exportable

AsExportable returns this File as a Exportable. This is a local type conversion — no GraphQL call.

func (*File) AsJSON

func (r *File) AsJSON() *JSONValue

Parse the file contents as JSON.

func (*File) AsNode

func (r *File) AsNode() Node

AsNode returns this File as a Node. This is a local type conversion — no GraphQL call.

func (*File) AsSyncer

func (r *File) AsSyncer() Syncer

AsSyncer returns this File as a Syncer. This is a local type conversion — no GraphQL call.

func (*File) Chown

func (r *File) Chown(owner string) *File

Change the owner of the file recursively.

func (*File) Contents

func (r *File) Contents(ctx context.Context, opts ...FileContentsOpts) (string, error)

Retrieves the contents of the file.

func (*File) Digest

func (r *File) Digest(ctx context.Context, opts ...FileDigestOpts) (string, error)

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.

func (*File) Export

func (r *File) Export(ctx context.Context, path string, opts ...FileExportOpts) (string, error)

Writes the file to a file path on the host.

func (*File) ID

func (r *File) ID(ctx context.Context) (ID, error)

A unique identifier for this File.

func (*File) MarshalJSON

func (r *File) MarshalJSON() ([]byte, error)

func (*File) Name

func (r *File) Name(ctx context.Context) (string, error)

Retrieves the name of the file.

func (*File) Search

func (r *File) Search(ctx context.Context, pattern string, opts ...FileSearchOpts) ([]SearchResult, error)

Searches for content matching the given regular expression or literal string.

Uses Rust regex syntax; escape literal ., [, ], {, }, | with backslashes.

func (*File) Size

func (r *File) Size(ctx context.Context) (int, error)

Retrieves the size of the file, in bytes.

func (*File) Stat

func (r *File) Stat() *Stat

Return file status

func (*File) Sync

func (r *File) Sync(ctx context.Context) (*File, error)

Force evaluation in the engine.

func (*File) With

func (r *File) With(f WithFileFunc) *File

With calls the provided function with current File.

This is useful for reusability and readability by not breaking the calling chain.

func (*File) WithGraphQLQuery

func (r *File) WithGraphQLQuery(q *querybuilder.Selection) *File

func (*File) WithName

func (r *File) WithName(name string) *File

Retrieves this file with its name set to the given name.

func (*File) WithReplaced

func (r *File) WithReplaced(search string, replacement string, opts ...FileWithReplacedOpts) *File

Retrieves the file with content replaced with the given text.

If 'all' is true, all occurrences of the pattern will be replaced.

If 'firstAfter' is specified, only the first match starting at the specified line will be replaced.

If neither are specified, and there are multiple matches for the pattern, this will error.

If there are no matches for the pattern, this will error.

func (*File) WithTimestamps

func (r *File) WithTimestamps(timestamp int) *File

Retrieves this file with its created/modified timestamps set to the given time.

func (*File) XXX_GraphQLID

func (r *File) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*File) XXX_GraphQLIDType

func (r *File) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*File) XXX_GraphQLType

func (r *File) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FileAsEnvFileOpts

type FileAsEnvFileOpts struct {
	// Replace "${VAR}" or "$VAR" with the value of other vars
	// Deprecated: Variable expansion is now enabled by default
	Expand bool
}

FileAsEnvFileOpts contains options for File.AsEnvFile

type FileContentsOpts

type FileContentsOpts struct {
	// Start reading after this line
	OffsetLines int
	// Maximum number of lines to read
	LimitLines int
}

FileContentsOpts contains options for File.Contents

type FileDigestOpts

type FileDigestOpts struct {
	// If true, exclude metadata from the digest.
	ExcludeMetadata bool
}

FileDigestOpts contains options for File.Digest

type FileExportOpts

type FileExportOpts struct {
	// If allowParentDirPath is true, the path argument can be a directory path, in which case the file will be created in that directory.
	AllowParentDirPath bool
}

FileExportOpts contains options for File.Export

type FileID

type FileID string

A unique identifier for an object.

type FileOpts

type FileOpts struct {
	// Permissions of the new file. Example: 0600
	//
	// Default: 420
	Permissions int
}

FileOpts contains options for Query.File

type FileSearchOpts

type FileSearchOpts struct {
	// Interpret the pattern as a literal string instead of a regular expression.
	Literal bool
	// Enable searching across multiple lines.
	Multiline bool
	// Allow the . pattern to match newlines in multiline mode.
	Dotall bool
	// Enable case-insensitive matching.
	Insensitive bool
	// Honor .gitignore, .ignore, and .rgignore files.
	SkipIgnored bool
	// Skip hidden files (files starting with .).
	SkipHidden bool
	// Only return matching files, not lines and content
	FilesOnly bool
	// Limit the number of results to return
	Limit int

	Paths []string

	Globs []string
}

FileSearchOpts contains options for File.Search

type FileType

type FileType string

File type.

const (
	// unknown file type
	FileTypeUnknown FileType = "UNKNOWN"

	// regular file type
	FileTypeRegular FileType = "REGULAR"
	// regular file type
	FileTypeRegularType FileType = FileTypeRegular

	// directory file type
	FileTypeDirectory FileType = "DIRECTORY"
	// directory file type
	FileTypeDirectoryType FileType = FileTypeDirectory

	// symlink file type
	FileTypeSymlink FileType = "SYMLINK"
	// symlink file type
	FileTypeSymlinkType FileType = FileTypeSymlink
)

func (FileType) IsEnum

func (FileType) IsEnum()

func (*FileType) MarshalJSON

func (v *FileType) MarshalJSON() ([]byte, error)

func (FileType) Name

func (v FileType) Name() string

func (*FileType) UnmarshalJSON

func (v *FileType) UnmarshalJSON(dt []byte) error

func (FileType) Value

func (v FileType) Value() string

type FileWithReplacedOpts

type FileWithReplacedOpts struct {
	// Replace all occurrences of the pattern.
	All bool
	// Replace the first match starting from the specified line.
	FirstFrom int
}

FileWithReplacedOpts contains options for File.WithReplaced

type Function

type Function struct {
	// contains filtered or unexported fields
}

Function represents a resolver provided by a Module.

A function always evaluates against a parent object and is given a set of named arguments.

func (*Function) Args

func (r *Function) Args(ctx context.Context) ([]FunctionArg, error)

Arguments accepted by the function, if any.

func (*Function) AsNode

func (r *Function) AsNode() Node

AsNode returns this Function as a Node. This is a local type conversion — no GraphQL call.

func (*Function) Deprecated

func (r *Function) Deprecated(ctx context.Context) (string, error)

The reason this function is deprecated, if any.

func (*Function) Description

func (r *Function) Description(ctx context.Context) (string, error)

A doc string for the function, if any.

func (*Function) ID

func (r *Function) ID(ctx context.Context) (ID, error)

A unique identifier for this Function.

func (*Function) MarshalJSON

func (r *Function) MarshalJSON() ([]byte, error)

func (*Function) Name

func (r *Function) Name(ctx context.Context) (string, error)

The name of the function.

func (*Function) ReturnType

func (r *Function) ReturnType() *TypeDef

The type returned by the function.

func (*Function) SourceMap

func (r *Function) SourceMap() *SourceMap

The location of this function declaration.

func (*Function) SourceModuleName

func (r *Function) SourceModuleName(ctx context.Context) (string, error)

If this function is provided by a module, the name of the module. Unset otherwise.

func (*Function) With

func (r *Function) With(f WithFunctionFunc) *Function

With calls the provided function with current Function.

This is useful for reusability and readability by not breaking the calling chain.

func (*Function) WithArg

func (r *Function) WithArg(name string, typeDef *TypeDef, opts ...FunctionWithArgOpts) *Function

Returns the function with the provided argument

func (*Function) WithCachePolicy

func (r *Function) WithCachePolicy(policy FunctionCachePolicy, opts ...FunctionWithCachePolicyOpts) *Function

Returns the function updated to use the provided cache policy.

func (*Function) WithCheck

func (r *Function) WithCheck() *Function

Returns the function with a flag indicating it's a check.

func (*Function) WithDeprecated

func (r *Function) WithDeprecated(opts ...FunctionWithDeprecatedOpts) *Function

Returns the function with the provided deprecation reason.

func (*Function) WithDescription

func (r *Function) WithDescription(description string) *Function

Returns the function with the given doc string.

func (*Function) WithGenerator

func (r *Function) WithGenerator() *Function

Returns the function with a flag indicating it's a generator.

func (*Function) WithGraphQLQuery

func (r *Function) WithGraphQLQuery(q *querybuilder.Selection) *Function

func (*Function) WithSourceMap

func (r *Function) WithSourceMap(sourceMap *SourceMap) *Function

Returns the function with the given source map.

func (*Function) WithUp

func (r *Function) WithUp() *Function

Returns the function with a flag indicating it returns a service for dagger up.

func (*Function) XXX_GraphQLID

func (r *Function) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Function) XXX_GraphQLIDType

func (r *Function) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Function) XXX_GraphQLType

func (r *Function) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FunctionArg

type FunctionArg struct {
	// contains filtered or unexported fields
}

An argument accepted by a function.

This is a specification for an argument at function definition time, not an argument passed at function call time.

func (*FunctionArg) AsNode

func (r *FunctionArg) AsNode() Node

AsNode returns this FunctionArg as a Node. This is a local type conversion — no GraphQL call.

func (*FunctionArg) DefaultAddress

func (r *FunctionArg) DefaultAddress(ctx context.Context) (string, error)

Only applies to arguments of type Container. If the argument is not set, load it from the given address (e.g. alpine:latest)

func (*FunctionArg) DefaultPath

func (r *FunctionArg) DefaultPath(ctx context.Context) (string, error)

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

func (*FunctionArg) DefaultValue

func (r *FunctionArg) DefaultValue(ctx context.Context) (JSON, error)

A default value to use for this argument when not explicitly set by the caller, if any.

func (*FunctionArg) Deprecated

func (r *FunctionArg) Deprecated(ctx context.Context) (string, error)

The reason this function is deprecated, if any.

func (*FunctionArg) Description

func (r *FunctionArg) Description(ctx context.Context) (string, error)

A doc string for the argument, if any.

func (*FunctionArg) ID

func (r *FunctionArg) ID(ctx context.Context) (ID, error)

A unique identifier for this FunctionArg.

func (*FunctionArg) Ignore

func (r *FunctionArg) Ignore(ctx context.Context) ([]string, error)

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.

func (*FunctionArg) MarshalJSON

func (r *FunctionArg) MarshalJSON() ([]byte, error)

func (*FunctionArg) Name

func (r *FunctionArg) Name(ctx context.Context) (string, error)

The name of the argument in lowerCamelCase format.

func (*FunctionArg) SourceMap

func (r *FunctionArg) SourceMap() *SourceMap

The location of this arg declaration.

func (*FunctionArg) TypeDef

func (r *FunctionArg) TypeDef() *TypeDef

The type of the argument.

func (*FunctionArg) WithGraphQLQuery

func (r *FunctionArg) WithGraphQLQuery(q *querybuilder.Selection) *FunctionArg

func (*FunctionArg) XXX_GraphQLID

func (r *FunctionArg) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*FunctionArg) XXX_GraphQLIDType

func (r *FunctionArg) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*FunctionArg) XXX_GraphQLType

func (r *FunctionArg) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FunctionArgID

type FunctionArgID string

A unique identifier for an object.

type FunctionCachePolicy

type FunctionCachePolicy string

The behavior configured for function result caching.

const (
	FunctionCachePolicyDefault FunctionCachePolicy = "Default"

	FunctionCachePolicyPerSession FunctionCachePolicy = "PerSession"

	FunctionCachePolicyNever FunctionCachePolicy = "Never"
)

func (FunctionCachePolicy) IsEnum

func (FunctionCachePolicy) IsEnum()

func (*FunctionCachePolicy) MarshalJSON

func (v *FunctionCachePolicy) MarshalJSON() ([]byte, error)

func (FunctionCachePolicy) Name

func (v FunctionCachePolicy) Name() string

func (*FunctionCachePolicy) UnmarshalJSON

func (v *FunctionCachePolicy) UnmarshalJSON(dt []byte) error

func (FunctionCachePolicy) Value

func (v FunctionCachePolicy) Value() string

type FunctionCall

type FunctionCall struct {
	// contains filtered or unexported fields
}

An active function call.

func (*FunctionCall) AsNode

func (r *FunctionCall) AsNode() Node

AsNode returns this FunctionCall as a Node. This is a local type conversion — no GraphQL call.

func (*FunctionCall) ID

func (r *FunctionCall) ID(ctx context.Context) (ID, error)

A unique identifier for this FunctionCall.

func (*FunctionCall) InputArgs

func (r *FunctionCall) InputArgs(ctx context.Context) ([]FunctionCallArgValue, error)

The argument values the function is being invoked with.

func (*FunctionCall) MarshalJSON

func (r *FunctionCall) MarshalJSON() ([]byte, error)

func (*FunctionCall) Name

func (r *FunctionCall) Name(ctx context.Context) (string, error)

The name of the function being called.

func (*FunctionCall) Parent

func (r *FunctionCall) Parent(ctx context.Context) (JSON, error)

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.

func (*FunctionCall) ParentName

func (r *FunctionCall) ParentName(ctx context.Context) (string, error)

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.

func (*FunctionCall) ReturnError

func (r *FunctionCall) ReturnError(ctx context.Context, error *Error) error

Return an error from the function.

func (*FunctionCall) ReturnValue

func (r *FunctionCall) ReturnValue(ctx context.Context, value JSON) error

Set the return value of the function call to the provided value.

func (*FunctionCall) WithGraphQLQuery

func (r *FunctionCall) WithGraphQLQuery(q *querybuilder.Selection) *FunctionCall

func (*FunctionCall) XXX_GraphQLID

func (r *FunctionCall) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*FunctionCall) XXX_GraphQLIDType

func (r *FunctionCall) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*FunctionCall) XXX_GraphQLType

func (r *FunctionCall) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FunctionCallArgValue

type FunctionCallArgValue struct {
	// contains filtered or unexported fields
}

A value passed as a named argument to a function call.

func (*FunctionCallArgValue) AsNode

func (r *FunctionCallArgValue) AsNode() Node

AsNode returns this FunctionCallArgValue as a Node. This is a local type conversion — no GraphQL call.

func (*FunctionCallArgValue) ID

A unique identifier for this FunctionCallArgValue.

func (*FunctionCallArgValue) MarshalJSON

func (r *FunctionCallArgValue) MarshalJSON() ([]byte, error)

func (*FunctionCallArgValue) Name

The name of the argument.

func (*FunctionCallArgValue) Value

func (r *FunctionCallArgValue) Value(ctx context.Context) (JSON, error)

The value of the argument represented as a JSON serialized string.

func (*FunctionCallArgValue) WithGraphQLQuery

func (*FunctionCallArgValue) XXX_GraphQLID

func (r *FunctionCallArgValue) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*FunctionCallArgValue) XXX_GraphQLIDType

func (r *FunctionCallArgValue) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*FunctionCallArgValue) XXX_GraphQLType

func (r *FunctionCallArgValue) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type FunctionCallArgValueID

type FunctionCallArgValueID string

A unique identifier for an object.

type FunctionCallID

type FunctionCallID string

A unique identifier for an object.

type FunctionID

type FunctionID string

A unique identifier for an object.

type FunctionWithArgOpts

type FunctionWithArgOpts struct {
	// A doc string for the argument, if any
	Description string
	// A default value to use for this argument if not explicitly set by the caller, if any
	DefaultValue JSON
	// If the argument is a Directory or File type, default to load path from context directory, relative to root directory.
	DefaultPath string
	// Patterns to ignore when loading the contextual argument value.
	Ignore []string
	// The source map for the argument definition.
	SourceMap *SourceMap
	// If deprecated, the reason or migration path.
	Deprecated string

	DefaultAddress string
}

FunctionWithArgOpts contains options for Function.WithArg

type FunctionWithCachePolicyOpts

type FunctionWithCachePolicyOpts struct {
	// The TTL for the cache policy, if applicable. Provided as a duration string, e.g. "5m", "1h30s".
	TimeToLive string
}

FunctionWithCachePolicyOpts contains options for Function.WithCachePolicy

type FunctionWithDeprecatedOpts

type FunctionWithDeprecatedOpts struct {
	// Reason or migration path describing the deprecation.
	Reason string
}

FunctionWithDeprecatedOpts contains options for Function.WithDeprecated

type GeneratedCode

type GeneratedCode struct {
	// contains filtered or unexported fields
}

The result of running an SDK's codegen.

func (*GeneratedCode) AsNode

func (r *GeneratedCode) AsNode() Node

AsNode returns this GeneratedCode as a Node. This is a local type conversion — no GraphQL call.

func (*GeneratedCode) Code

func (r *GeneratedCode) Code() *Directory

The directory containing the generated code.

func (*GeneratedCode) ID

func (r *GeneratedCode) ID(ctx context.Context) (ID, error)

A unique identifier for this GeneratedCode.

func (*GeneratedCode) MarshalJSON

func (r *GeneratedCode) MarshalJSON() ([]byte, error)

func (*GeneratedCode) VcsGeneratedPaths

func (r *GeneratedCode) VcsGeneratedPaths(ctx context.Context) ([]string, error)

List of paths to mark generated in version control (i.e. .gitattributes).

func (*GeneratedCode) VcsIgnoredPaths

func (r *GeneratedCode) VcsIgnoredPaths(ctx context.Context) ([]string, error)

List of paths to ignore in version control (i.e. .gitignore).

func (*GeneratedCode) With

With calls the provided function with current GeneratedCode.

This is useful for reusability and readability by not breaking the calling chain.

func (*GeneratedCode) WithGraphQLQuery

func (r *GeneratedCode) WithGraphQLQuery(q *querybuilder.Selection) *GeneratedCode

func (*GeneratedCode) WithVCSGeneratedPaths

func (r *GeneratedCode) WithVCSGeneratedPaths(paths []string) *GeneratedCode

Set the list of paths to mark generated in version control.

func (*GeneratedCode) WithVCSIgnoredPaths

func (r *GeneratedCode) WithVCSIgnoredPaths(paths []string) *GeneratedCode

Set the list of paths to ignore in version control.

func (*GeneratedCode) XXX_GraphQLID

func (r *GeneratedCode) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*GeneratedCode) XXX_GraphQLIDType

func (r *GeneratedCode) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*GeneratedCode) XXX_GraphQLType

func (r *GeneratedCode) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GeneratedCodeID

type GeneratedCodeID string

A unique identifier for an object.

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

func (*Generator) AsNode

func (r *Generator) AsNode() Node

AsNode returns this Generator as a Node. This is a local type conversion — no GraphQL call.

func (*Generator) Changes

func (r *Generator) Changes() *Changeset

The generated changeset from the last run

func (*Generator) Completed

func (r *Generator) Completed(ctx context.Context) (bool, error)

Whether the generator complete

func (*Generator) Description

func (r *Generator) Description(ctx context.Context) (string, error)

Return the description of the generator

func (*Generator) ID

func (r *Generator) ID(ctx context.Context) (ID, error)

A unique identifier for this Generator.

func (*Generator) IsEmpty

func (r *Generator) IsEmpty(ctx context.Context) (bool, error)

Whether changeset from the last generator run is empty or not

func (*Generator) MarshalJSON

func (r *Generator) MarshalJSON() ([]byte, error)

func (*Generator) Name

func (r *Generator) Name(ctx context.Context) (string, error)

Return the fully qualified name of the generator

func (*Generator) OriginalModule

func (r *Generator) OriginalModule() *Module

The original module in which the generator has been defined

func (*Generator) Path

func (r *Generator) Path(ctx context.Context) ([]string, error)

The path of the generator within its module

func (*Generator) Run

func (r *Generator) Run() *Generator

Execute the generator

func (*Generator) With

With calls the provided function with current Generator.

This is useful for reusability and readability by not breaking the calling chain.

func (*Generator) WithGraphQLQuery

func (r *Generator) WithGraphQLQuery(q *querybuilder.Selection) *Generator

func (*Generator) XXX_GraphQLID

func (r *Generator) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Generator) XXX_GraphQLIDType

func (r *Generator) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Generator) XXX_GraphQLType

func (r *Generator) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GeneratorGroup

type GeneratorGroup struct {
	// contains filtered or unexported fields
}

func (*GeneratorGroup) AsNode

func (r *GeneratorGroup) AsNode() Node

AsNode returns this GeneratorGroup as a Node. This is a local type conversion — no GraphQL call.

func (*GeneratorGroup) Changes

func (r *GeneratorGroup) Changes(opts ...GeneratorGroupChangesOpts) *Changeset

The combined changes from the last run of the generators

If any conflict occurs, for instance if the same file is modified by multiple generators, or if a file is both modified and deleted, an error is raised and the merge of the changesets will failed.

Set 'continueOnConflicts' flag to force to merge the changes in a 'last write wins' strategy.

func (*GeneratorGroup) ID

func (r *GeneratorGroup) ID(ctx context.Context) (ID, error)

A unique identifier for this GeneratorGroup.

func (*GeneratorGroup) IsEmpty

func (r *GeneratorGroup) IsEmpty(ctx context.Context) (bool, error)

Whether the generated changeset from the last run is empty or not

func (*GeneratorGroup) List

func (r *GeneratorGroup) List(ctx context.Context) ([]Generator, error)

Return a list of individual generators and their details

func (*GeneratorGroup) MarshalJSON

func (r *GeneratorGroup) MarshalJSON() ([]byte, error)

func (*GeneratorGroup) Run

func (r *GeneratorGroup) Run() *GeneratorGroup

Execute all selected generators

func (*GeneratorGroup) With

With calls the provided function with current GeneratorGroup.

This is useful for reusability and readability by not breaking the calling chain.

func (*GeneratorGroup) WithGraphQLQuery

func (r *GeneratorGroup) WithGraphQLQuery(q *querybuilder.Selection) *GeneratorGroup

func (*GeneratorGroup) XXX_GraphQLID

func (r *GeneratorGroup) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*GeneratorGroup) XXX_GraphQLIDType

func (r *GeneratorGroup) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*GeneratorGroup) XXX_GraphQLType

func (r *GeneratorGroup) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GeneratorGroupChangesOpts

type GeneratorGroupChangesOpts struct {
	// Strategy to apply on conflicts between generators
	//
	// Default: FAIL_EARLY
	OnConflict ChangesetsMergeConflict
}

GeneratorGroupChangesOpts contains options for GeneratorGroup.Changes

type GeneratorGroupID

type GeneratorGroupID string

A unique identifier for an object.

type GeneratorID

type GeneratorID string

A unique identifier for an object.

type GitOpts

type GitOpts struct {
	// DEPRECATED: Set to true to keep .git directory.
	//
	// Default: true
	// Deprecated: Set to true to keep .git directory.
	KeepGitDir bool
	// Set SSH known hosts
	SSHKnownHosts string
	// Set SSH auth socket
	SSHAuthSocket *Socket
	// Username used to populate the password during basic HTTP Authorization
	HTTPAuthUsername string
	// Secret used to populate the password during basic HTTP Authorization
	HTTPAuthToken *Secret
	// Secret used to populate the Authorization HTTP header
	HTTPAuthHeader *Secret
	// A service which must be started before the repo is fetched.
	ExperimentalServiceHost *Service
}

GitOpts contains options for Query.Git

type GitRef

type GitRef struct {
	// contains filtered or unexported fields
}

A git ref (tag, branch, or commit).

func (*GitRef) AsNode

func (r *GitRef) AsNode() Node

AsNode returns this GitRef as a Node. This is a local type conversion — no GraphQL call.

func (*GitRef) Commit

func (r *GitRef) Commit(ctx context.Context) (string, error)

The resolved commit id at this ref.

func (*GitRef) CommonAncestor

func (r *GitRef) CommonAncestor(other *GitRef) *GitRef

Find the best common ancestor between this ref and another ref.

func (*GitRef) ID

func (r *GitRef) ID(ctx context.Context) (ID, error)

A unique identifier for this GitRef.

func (*GitRef) MarshalJSON

func (r *GitRef) MarshalJSON() ([]byte, error)

func (*GitRef) Ref

func (r *GitRef) Ref(ctx context.Context) (string, error)

The resolved ref name at this ref.

func (*GitRef) Tree

func (r *GitRef) Tree(opts ...GitRefTreeOpts) *Directory

The filesystem tree at this ref.

func (*GitRef) With

func (r *GitRef) With(f WithGitRefFunc) *GitRef

With calls the provided function with current GitRef.

This is useful for reusability and readability by not breaking the calling chain.

func (*GitRef) WithGraphQLQuery

func (r *GitRef) WithGraphQLQuery(q *querybuilder.Selection) *GitRef

func (*GitRef) XXX_GraphQLID

func (r *GitRef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*GitRef) XXX_GraphQLIDType

func (r *GitRef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*GitRef) XXX_GraphQLType

func (r *GitRef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GitRefID

type GitRefID string

A unique identifier for an object.

type GitRefTreeOpts

type GitRefTreeOpts struct {
	// Set to true to discard .git directory.
	DiscardGitDir bool
	// The depth of the tree to fetch.
	//
	// Default: 1
	Depth int
	// Set to true to populate tag refs in the local checkout .git.
	IncludeTags bool
}

GitRefTreeOpts contains options for GitRef.Tree

type GitRepository

type GitRepository struct {
	// contains filtered or unexported fields
}

A git repository.

func (*GitRepository) AsNode

func (r *GitRepository) AsNode() Node

AsNode returns this GitRepository as a Node. This is a local type conversion — no GraphQL call.

func (*GitRepository) Branch

func (r *GitRepository) Branch(name string) *GitRef

Returns details of a branch.

func (*GitRepository) Branches

func (r *GitRepository) Branches(ctx context.Context, opts ...GitRepositoryBranchesOpts) ([]string, error)

branches that match any of the given glob patterns.

func (*GitRepository) Commit

func (r *GitRepository) Commit(id string) *GitRef

Returns details of a commit.

func (*GitRepository) Head

func (r *GitRepository) Head() *GitRef

Returns details for HEAD.

func (*GitRepository) ID

func (r *GitRepository) ID(ctx context.Context) (ID, error)

A unique identifier for this GitRepository.

func (*GitRepository) LatestVersion

func (r *GitRepository) LatestVersion() *GitRef

Returns details for the latest semver tag.

func (*GitRepository) MarshalJSON

func (r *GitRepository) MarshalJSON() ([]byte, error)

func (*GitRepository) Ref

func (r *GitRepository) Ref(name string) *GitRef

Returns details of a ref.

func (*GitRepository) Tag

func (r *GitRepository) Tag(name string) *GitRef

Returns details of a tag.

func (*GitRepository) Tags

func (r *GitRepository) Tags(ctx context.Context, opts ...GitRepositoryTagsOpts) ([]string, error)

tags that match any of the given glob patterns.

func (*GitRepository) URL

func (r *GitRepository) URL(ctx context.Context) (string, error)

The URL of the git repository.

func (*GitRepository) Uncommitted

func (r *GitRepository) Uncommitted() *Changeset

Returns the changeset of uncommitted changes in the git repository.

func (*GitRepository) WithGraphQLQuery

func (r *GitRepository) WithGraphQLQuery(q *querybuilder.Selection) *GitRepository

func (*GitRepository) XXX_GraphQLID

func (r *GitRepository) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*GitRepository) XXX_GraphQLIDType

func (r *GitRepository) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*GitRepository) XXX_GraphQLType

func (r *GitRepository) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GitRepositoryBranchesOpts

type GitRepositoryBranchesOpts struct {
	// Glob patterns (e.g., "refs/tags/v*").
	Patterns []string
}

GitRepositoryBranchesOpts contains options for GitRepository.Branches

type GitRepositoryID

type GitRepositoryID string

A unique identifier for an object.

type GitRepositoryTagsOpts

type GitRepositoryTagsOpts struct {
	// Glob patterns (e.g., "refs/tags/v*").
	Patterns []string
}

GitRepositoryTagsOpts contains options for GitRepository.Tags

type Go

type Go struct {
	// contains filtered or unexported fields
}

func (*Go) AsNode

func (r *Go) AsNode() Node

AsNode returns this Go as a Node. This is a local type conversion — no GraphQL call.

func (*Go) Build

func (r *Go) Build(opts ...GoBuildOpts) *File

func (*Go) Container

func (r *Go) Container() *Container

func (*Go) Fmt

func (r *Go) Fmt(opts ...GoFmtOpts) *Changeset

func (*Go) ID

func (r *Go) ID(ctx context.Context) (ID, error)

A unique identifier for this Go.

func (*Go) MarshalJSON

func (r *Go) MarshalJSON() ([]byte, error)

func (*Go) Staticcheck

func (r *Go) Staticcheck(ctx context.Context, opts ...GoStaticcheckOpts) error

func (*Go) Test

func (r *Go) Test(ctx context.Context, opts ...GoTestOpts) error

func (*Go) Tidy

func (r *Go) Tidy() *Changeset

func (*Go) Vet

func (r *Go) Vet(ctx context.Context) error

func (*Go) Vulncheck

func (r *Go) Vulncheck(ctx context.Context, opts ...GoVulncheckOpts) error

func (*Go) WithGraphQLQuery

func (r *Go) WithGraphQLQuery(q *querybuilder.Selection) *Go

func (*Go) XXX_GraphQLID

func (r *Go) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Go) XXX_GraphQLIDType

func (r *Go) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Go) XXX_GraphQLType

func (r *Go) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type GoFmtOpts

GoFmtOpts contains options for Go.Fmt

type GoID

type GoID string

A unique identifier for an object.

type GoStaticcheckOpts

type GoStaticcheckOpts struct {

	// Default: "latest"
	Version string // go (https://github.com/frantjc/daggerverse/tree/f22c1fc85dfa656d4216ea5a5086dee4eabefd5a/go/main.go#L213)
}

GoStaticcheckOpts contains options for Go.Staticcheck

type GoVulncheckOpts

type GoVulncheckOpts struct {

	// Default: "latest"
	Version string // go (https://github.com/frantjc/daggerverse/tree/f22c1fc85dfa656d4216ea5a5086dee4eabefd5a/go/main.go#L191)
}

GoVulncheckOpts contains options for Go.Vulncheck

type HTTPOpts

type HTTPOpts struct {
	// File name to use for the file. Defaults to the last part of the URL.
	Name string
	// Permissions to set on the file.
	Permissions int
	// Expected digest of the downloaded content (e.g., "sha256:...").
	Checksum string
	// Secret used to populate the Authorization HTTP header
	AuthHeader *Secret
	// A service which must be started before the URL is fetched.
	ExperimentalServiceHost *Service
}

HTTPOpts contains options for Query.HTTP

type HTTPState

type HTTPState struct {
	// contains filtered or unexported fields
}

An internal persistent HTTP state.

func (*HTTPState) AsNode

func (r *HTTPState) AsNode() Node

AsNode returns this HTTPState as a Node. This is a local type conversion — no GraphQL call.

func (*HTTPState) ID

func (r *HTTPState) ID(ctx context.Context) (ID, error)

A unique identifier for this HTTPState.

func (*HTTPState) MarshalJSON

func (r *HTTPState) MarshalJSON() ([]byte, error)

func (*HTTPState) WithGraphQLQuery

func (r *HTTPState) WithGraphQLQuery(q *querybuilder.Selection) *HTTPState

func (*HTTPState) XXX_GraphQLID

func (r *HTTPState) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*HTTPState) XXX_GraphQLIDType

func (r *HTTPState) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*HTTPState) XXX_GraphQLType

func (r *HTTPState) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type HTTPStateID

type HTTPStateID string

A unique identifier for an object.

type HealthcheckConfig

type HealthcheckConfig struct {
	// contains filtered or unexported fields
}

Image healthcheck configuration.

func (*HealthcheckConfig) Args

func (r *HealthcheckConfig) Args(ctx context.Context) ([]string, error)

Healthcheck command arguments.

func (*HealthcheckConfig) AsNode

func (r *HealthcheckConfig) AsNode() Node

AsNode returns this HealthcheckConfig as a Node. This is a local type conversion — no GraphQL call.

func (*HealthcheckConfig) ID

func (r *HealthcheckConfig) ID(ctx context.Context) (ID, error)

A unique identifier for this HealthcheckConfig.

func (*HealthcheckConfig) Interval

func (r *HealthcheckConfig) Interval(ctx context.Context) (string, error)

Interval between running healthcheck. Example:30s

func (*HealthcheckConfig) MarshalJSON

func (r *HealthcheckConfig) MarshalJSON() ([]byte, error)

func (*HealthcheckConfig) Retries

func (r *HealthcheckConfig) Retries(ctx context.Context) (int, error)

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

func (*HealthcheckConfig) Shell

func (r *HealthcheckConfig) Shell(ctx context.Context) (bool, error)

Healthcheck command is a shell command.

func (*HealthcheckConfig) StartInterval

func (r *HealthcheckConfig) StartInterval(ctx context.Context) (string, error)

StartInterval configures the duration between checks during the startup phase. Example:5s

func (*HealthcheckConfig) StartPeriod

func (r *HealthcheckConfig) StartPeriod(ctx context.Context) (string, error)

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

func (*HealthcheckConfig) Timeout

func (r *HealthcheckConfig) Timeout(ctx context.Context) (string, error)

Healthcheck timeout. Example:3s

func (*HealthcheckConfig) WithGraphQLQuery

func (r *HealthcheckConfig) WithGraphQLQuery(q *querybuilder.Selection) *HealthcheckConfig

func (*HealthcheckConfig) XXX_GraphQLID

func (r *HealthcheckConfig) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*HealthcheckConfig) XXX_GraphQLIDType

func (r *HealthcheckConfig) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*HealthcheckConfig) XXX_GraphQLType

func (r *HealthcheckConfig) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type HealthcheckConfigID

type HealthcheckConfigID string

A unique identifier for an object.

type Host

type Host struct {
	// contains filtered or unexported fields
}

Information about the host environment.

func (*Host) AsNode

func (r *Host) AsNode() Node

AsNode returns this Host as a Node. This is a local type conversion — no GraphQL call.

func (*Host) ContainerImage

func (r *Host) ContainerImage(name string) *Container

Accesses a container image on the host.

func (*Host) Directory

func (r *Host) Directory(path string, opts ...HostDirectoryOpts) *Directory

Accesses a directory on the host.

func (*Host) File

func (r *Host) File(path string, opts ...HostFileOpts) *File

Accesses a file on the host.

func (*Host) FindUp

func (r *Host) FindUp(ctx context.Context, name string, opts ...HostFindUpOpts) (string, error)

Search for a file or directory by walking up the tree from system workdir. Return its relative path. If no match, return null

func (*Host) ID

func (r *Host) ID(ctx context.Context) (ID, error)

A unique identifier for this Host.

func (*Host) MarshalJSON

func (r *Host) MarshalJSON() ([]byte, error)

func (*Host) Service

func (r *Host) Service(ports []PortForward, opts ...HostServiceOpts) *Service

Creates a service that forwards traffic to a specified address via the host.

func (*Host) Tunnel

func (r *Host) Tunnel(service *Service, opts ...HostTunnelOpts) *Service

Creates a tunnel that forwards traffic from the host to a service.

func (*Host) UnixSocket

func (r *Host) UnixSocket(path string) *Socket

Accesses a Unix socket on the host.

func (*Host) WithGraphQLQuery

func (r *Host) WithGraphQLQuery(q *querybuilder.Selection) *Host

func (*Host) XXX_GraphQLID

func (r *Host) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Host) XXX_GraphQLIDType

func (r *Host) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Host) XXX_GraphQLType

func (r *Host) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type HostDirectoryOpts

type HostDirectoryOpts struct {
	// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
	Exclude []string
	// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
	Include []string
	// If true, the directory will always be reloaded from the host.
	NoCache bool
	// Apply .gitignore filter rules inside the directory
	Gitignore bool
}

HostDirectoryOpts contains options for Host.Directory

type HostFileOpts

type HostFileOpts struct {
	// If true, the file will always be reloaded from the host.
	NoCache bool
}

HostFileOpts contains options for Host.File

type HostFindUpOpts

type HostFindUpOpts struct {
	NoCache bool
}

HostFindUpOpts contains options for Host.FindUp

type HostID

type HostID string

A unique identifier for an object.

type HostServiceOpts

type HostServiceOpts struct {
	// Upstream host to forward traffic to.
	//
	// Default: "localhost"
	Host string
}

HostServiceOpts contains options for Host.Service

type HostTunnelOpts

type HostTunnelOpts struct {
	// Map each service port to the same port on the host, as if the service were running natively.
	//
	// Note: enabling may result in port conflicts.
	Native bool
	// Configure explicit port forwarding rules for the tunnel.
	//
	// If a port's frontend is unspecified or 0, a random port will be chosen by the host.
	//
	// If no ports are given, all of the service's ports are forwarded. If native is true, each port maps to the same port on the host. If native is false, each port maps to a random port chosen by the host.
	//
	// If ports are given and native is true, the ports are additive.
	Ports []PortForward
}

HostTunnelOpts contains options for Host.Tunnel

type ID

type ID string

A unique identifier for an object.

type ImageLayerCompression

type ImageLayerCompression string

Compression algorithm to use for image layers.

const (
	ImageLayerCompressionGzip ImageLayerCompression = "Gzip"

	ImageLayerCompressionZstd ImageLayerCompression = "Zstd"

	ImageLayerCompressionEstarGz ImageLayerCompression = "EStarGZ"
	ImageLayerCompressionEstargz ImageLayerCompression = ImageLayerCompressionEstarGz

	ImageLayerCompressionUncompressed ImageLayerCompression = "Uncompressed"
)

func (ImageLayerCompression) IsEnum

func (ImageLayerCompression) IsEnum()

func (*ImageLayerCompression) MarshalJSON

func (v *ImageLayerCompression) MarshalJSON() ([]byte, error)

func (ImageLayerCompression) Name

func (v ImageLayerCompression) Name() string

func (*ImageLayerCompression) UnmarshalJSON

func (v *ImageLayerCompression) UnmarshalJSON(dt []byte) error

func (ImageLayerCompression) Value

func (v ImageLayerCompression) Value() string

type ImageMediaTypes

type ImageMediaTypes string

Mediatypes to use in published or exported image metadata.

const (
	ImageMediaTypesOcimediaTypes ImageMediaTypes = "OCIMediaTypes"
	ImageMediaTypesOci           ImageMediaTypes = ImageMediaTypesOcimediaTypes

	ImageMediaTypesDockerMediaTypes ImageMediaTypes = "DockerMediaTypes"
	ImageMediaTypesDocker           ImageMediaTypes = ImageMediaTypesDockerMediaTypes
)

func (ImageMediaTypes) IsEnum

func (ImageMediaTypes) IsEnum()

func (*ImageMediaTypes) MarshalJSON

func (v *ImageMediaTypes) MarshalJSON() ([]byte, error)

func (ImageMediaTypes) Name

func (v ImageMediaTypes) Name() string

func (*ImageMediaTypes) UnmarshalJSON

func (v *ImageMediaTypes) UnmarshalJSON(dt []byte) error

func (ImageMediaTypes) Value

func (v ImageMediaTypes) Value() string

type InputTypeDef

type InputTypeDef struct {
	// contains filtered or unexported fields
}

A graphql input type, which is essentially just a group of named args. This is currently only used to represent pre-existing usage of graphql input types in the core API. It is not used by user modules and shouldn't ever be as user module accept input objects via their id rather than graphql input types.

func (*InputTypeDef) AsNode

func (r *InputTypeDef) AsNode() Node

AsNode returns this InputTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*InputTypeDef) Fields

func (r *InputTypeDef) Fields(ctx context.Context) ([]FieldTypeDef, error)

Static fields defined on this input object, if any.

func (*InputTypeDef) ID

func (r *InputTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this InputTypeDef.

func (*InputTypeDef) MarshalJSON

func (r *InputTypeDef) MarshalJSON() ([]byte, error)

func (*InputTypeDef) Name

func (r *InputTypeDef) Name(ctx context.Context) (string, error)

The name of the input object.

func (*InputTypeDef) WithGraphQLQuery

func (r *InputTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *InputTypeDef

func (*InputTypeDef) XXX_GraphQLID

func (r *InputTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*InputTypeDef) XXX_GraphQLIDType

func (r *InputTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*InputTypeDef) XXX_GraphQLType

func (r *InputTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type InputTypeDefID

type InputTypeDefID string

A unique identifier for an object.

type InterfaceTypeDef

type InterfaceTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a custom interface defined in a Module.

func (*InterfaceTypeDef) AsNode

func (r *InterfaceTypeDef) AsNode() Node

AsNode returns this InterfaceTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*InterfaceTypeDef) Description

func (r *InterfaceTypeDef) Description(ctx context.Context) (string, error)

The doc string for the interface, if any.

func (*InterfaceTypeDef) Functions

func (r *InterfaceTypeDef) Functions(ctx context.Context) ([]Function, error)

Functions defined on this interface, if any.

func (*InterfaceTypeDef) ID

func (r *InterfaceTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this InterfaceTypeDef.

func (*InterfaceTypeDef) MarshalJSON

func (r *InterfaceTypeDef) MarshalJSON() ([]byte, error)

func (*InterfaceTypeDef) Name

func (r *InterfaceTypeDef) Name(ctx context.Context) (string, error)

The name of the interface.

func (*InterfaceTypeDef) SourceMap

func (r *InterfaceTypeDef) SourceMap() *SourceMap

The location of this interface declaration.

func (*InterfaceTypeDef) SourceModuleName

func (r *InterfaceTypeDef) SourceModuleName(ctx context.Context) (string, error)

If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.

func (*InterfaceTypeDef) WithGraphQLQuery

func (r *InterfaceTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *InterfaceTypeDef

func (*InterfaceTypeDef) XXX_GraphQLID

func (r *InterfaceTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*InterfaceTypeDef) XXX_GraphQLIDType

func (r *InterfaceTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*InterfaceTypeDef) XXX_GraphQLType

func (r *InterfaceTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type InterfaceTypeDefID

type InterfaceTypeDefID string

A unique identifier for an object.

type JSON

type JSON string

An arbitrary JSON-encoded value.

type JSONValue

type JSONValue struct {
	// contains filtered or unexported fields
}

func (*JSONValue) AsArray

func (r *JSONValue) AsArray(ctx context.Context) ([]JSONValue, error)

Decode an array from json

func (*JSONValue) AsBoolean

func (r *JSONValue) AsBoolean(ctx context.Context) (bool, error)

Decode a boolean from json

func (*JSONValue) AsInteger

func (r *JSONValue) AsInteger(ctx context.Context) (int, error)

Decode an integer from json

func (*JSONValue) AsNode

func (r *JSONValue) AsNode() Node

AsNode returns this JSONValue as a Node. This is a local type conversion — no GraphQL call.

func (*JSONValue) AsString

func (r *JSONValue) AsString(ctx context.Context) (string, error)

Decode a string from json

func (*JSONValue) Contents

func (r *JSONValue) Contents(ctx context.Context, opts ...JSONValueContentsOpts) (JSON, error)

Return the value encoded as json

func (*JSONValue) Field

func (r *JSONValue) Field(path []string) *JSONValue

Lookup the field at the given path, and return its value.

func (*JSONValue) Fields

func (r *JSONValue) Fields(ctx context.Context) ([]string, error)

List fields of the encoded object

func (*JSONValue) ID

func (r *JSONValue) ID(ctx context.Context) (ID, error)

A unique identifier for this JSONValue.

func (*JSONValue) MarshalJSON

func (r *JSONValue) MarshalJSON() ([]byte, error)

func (*JSONValue) NewBoolean

func (r *JSONValue) NewBoolean(value bool) *JSONValue

Encode a boolean to json

func (*JSONValue) NewInteger

func (r *JSONValue) NewInteger(value int) *JSONValue

Encode an integer to json

func (*JSONValue) NewString

func (r *JSONValue) NewString(value string) *JSONValue

Encode a string to json

func (*JSONValue) With

With calls the provided function with current JSONValue.

This is useful for reusability and readability by not breaking the calling chain.

func (*JSONValue) WithContents

func (r *JSONValue) WithContents(contents JSON) *JSONValue

Return a new json value, decoded from the given content

func (*JSONValue) WithField

func (r *JSONValue) WithField(path []string, value *JSONValue) *JSONValue

Set a new field at the given path

func (*JSONValue) WithGraphQLQuery

func (r *JSONValue) WithGraphQLQuery(q *querybuilder.Selection) *JSONValue

func (*JSONValue) XXX_GraphQLID

func (r *JSONValue) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*JSONValue) XXX_GraphQLIDType

func (r *JSONValue) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*JSONValue) XXX_GraphQLType

func (r *JSONValue) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type JSONValueContentsOpts

type JSONValueContentsOpts struct {
	// Pretty-print
	Pretty bool
	// Optional line prefix
	//
	// Default: "  "
	Indent string
}

JSONValueContentsOpts contains options for JSONValue.Contents

type JSONValueID

type JSONValueID string

A unique identifier for an object.

type LLM

type LLM struct {
	// contains filtered or unexported fields
}

func (*LLM) AsNode

func (r *LLM) AsNode() Node

AsNode returns this LLM as a Node. This is a local type conversion — no GraphQL call.

func (*LLM) AsSyncer

func (r *LLM) AsSyncer() Syncer

AsSyncer returns this LLM as a Syncer. This is a local type conversion — no GraphQL call.

func (*LLM) Attempt

func (r *LLM) Attempt(number int) *LLM

create a branch in the LLM's history

func (*LLM) BindResult

func (r *LLM) BindResult(name string) *Binding

returns the type of the current state

func (*LLM) Env

func (r *LLM) Env() *Env

return the LLM's current environment

func (*LLM) HasPrompt

func (r *LLM) HasPrompt(ctx context.Context) (bool, error)

Indicates whether there are any queued prompts or tool results to send to the model

func (*LLM) History

func (r *LLM) History(ctx context.Context) ([]string, error)

return the llm message history

func (*LLM) HistoryJSON

func (r *LLM) HistoryJSON(ctx context.Context) (JSON, error)

return the raw llm message history as json

func (*LLM) ID

func (r *LLM) ID(ctx context.Context) (ID, error)

A unique identifier for this LLM.

func (*LLM) LastReply

func (r *LLM) LastReply(ctx context.Context) (string, error)

return the last llm reply from the history

func (*LLM) Loop

func (r *LLM) Loop() *LLM

Submit the queued prompt, evaluate any tool calls, queue their results, and keep going until the model ends its turn

func (*LLM) MarshalJSON

func (r *LLM) MarshalJSON() ([]byte, error)

func (*LLM) Model

func (r *LLM) Model(ctx context.Context) (string, error)

return the model used by the llm

func (*LLM) Provider

func (r *LLM) Provider(ctx context.Context) (string, error)

return the provider used by the llm

func (*LLM) Step

func (r *LLM) Step(ctx context.Context) (*LLM, error)

Submit the queued prompt or tool call results, evaluate any tool calls, and queue their results

func (*LLM) Sync

func (r *LLM) Sync(ctx context.Context) (*LLM, error)

synchronize LLM state

func (*LLM) TokenUsage

func (r *LLM) TokenUsage() *LLMTokenUsage

returns the token usage of the current state

func (*LLM) Tools

func (r *LLM) Tools(ctx context.Context) (string, error)

print documentation for available tools

func (*LLM) With

func (r *LLM) With(f WithLLMFunc) *LLM

With calls the provided function with current LLM.

This is useful for reusability and readability by not breaking the calling chain.

func (*LLM) WithBlockedFunction

func (r *LLM) WithBlockedFunction(typeName string, function string) *LLM

Return a new LLM with the specified function no longer exposed as a tool

func (*LLM) WithEnv

func (r *LLM) WithEnv(env *Env) *LLM

allow the LLM to interact with an environment via MCP

func (*LLM) WithGraphQLQuery

func (r *LLM) WithGraphQLQuery(q *querybuilder.Selection) *LLM

func (*LLM) WithMCPServer

func (r *LLM) WithMCPServer(name string, service *Service) *LLM

Add an external MCP server to the LLM

func (*LLM) WithModel

func (r *LLM) WithModel(model string) *LLM

swap out the llm model

func (*LLM) WithPrompt

func (r *LLM) WithPrompt(prompt string) *LLM

append a prompt to the llm context

func (*LLM) WithPromptFile

func (r *LLM) WithPromptFile(file *File) *LLM

append the contents of a file to the llm context

func (*LLM) WithStaticTools

func (r *LLM) WithStaticTools() *LLM

Use a static set of tools for method calls, e.g. for MCP clients that do not support dynamic tool registration

func (*LLM) WithSystemPrompt

func (r *LLM) WithSystemPrompt(prompt string) *LLM

Add a system prompt to the LLM's environment

func (*LLM) WithoutDefaultSystemPrompt

func (r *LLM) WithoutDefaultSystemPrompt() *LLM

Disable the default system prompt

func (*LLM) WithoutMessageHistory

func (r *LLM) WithoutMessageHistory() *LLM

Clear the message history, leaving only the system prompts

func (*LLM) WithoutSystemPrompts

func (r *LLM) WithoutSystemPrompts() *LLM

Clear the system prompts, leaving only the default system prompt

func (*LLM) XXX_GraphQLID

func (r *LLM) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*LLM) XXX_GraphQLIDType

func (r *LLM) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*LLM) XXX_GraphQLType

func (r *LLM) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type LLMID

type LLMID string

A unique identifier for an object.

type LLMOpts

type LLMOpts struct {
	// Model to use
	Model string
	// Cap the number of API calls for this LLM
	MaxAPICalls int
}

LLMOpts contains options for Query.LLM

type LLMTokenUsage

type LLMTokenUsage struct {
	// contains filtered or unexported fields
}

func (*LLMTokenUsage) AsNode

func (r *LLMTokenUsage) AsNode() Node

AsNode returns this LLMTokenUsage as a Node. This is a local type conversion — no GraphQL call.

func (*LLMTokenUsage) CachedTokenReads

func (r *LLMTokenUsage) CachedTokenReads(ctx context.Context) (int, error)

func (*LLMTokenUsage) CachedTokenWrites

func (r *LLMTokenUsage) CachedTokenWrites(ctx context.Context) (int, error)

func (*LLMTokenUsage) ID

func (r *LLMTokenUsage) ID(ctx context.Context) (ID, error)

A unique identifier for this LLMTokenUsage.

func (*LLMTokenUsage) InputTokens

func (r *LLMTokenUsage) InputTokens(ctx context.Context) (int, error)

func (*LLMTokenUsage) MarshalJSON

func (r *LLMTokenUsage) MarshalJSON() ([]byte, error)

func (*LLMTokenUsage) OutputTokens

func (r *LLMTokenUsage) OutputTokens(ctx context.Context) (int, error)

func (*LLMTokenUsage) TotalTokens

func (r *LLMTokenUsage) TotalTokens(ctx context.Context) (int, error)

func (*LLMTokenUsage) WithGraphQLQuery

func (r *LLMTokenUsage) WithGraphQLQuery(q *querybuilder.Selection) *LLMTokenUsage

func (*LLMTokenUsage) XXX_GraphQLID

func (r *LLMTokenUsage) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*LLMTokenUsage) XXX_GraphQLIDType

func (r *LLMTokenUsage) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*LLMTokenUsage) XXX_GraphQLType

func (r *LLMTokenUsage) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type LLMTokenUsageID

type LLMTokenUsageID string

A unique identifier for an object.

type Label

type Label struct {
	// contains filtered or unexported fields
}

A simple key value object that represents a label.

func (*Label) AsNode

func (r *Label) AsNode() Node

AsNode returns this Label as a Node. This is a local type conversion — no GraphQL call.

func (*Label) ID

func (r *Label) ID(ctx context.Context) (ID, error)

A unique identifier for this Label.

func (*Label) MarshalJSON

func (r *Label) MarshalJSON() ([]byte, error)

func (*Label) Name

func (r *Label) Name(ctx context.Context) (string, error)

The label name.

func (*Label) Value

func (r *Label) Value(ctx context.Context) (string, error)

The label value.

func (*Label) WithGraphQLQuery

func (r *Label) WithGraphQLQuery(q *querybuilder.Selection) *Label

func (*Label) XXX_GraphQLID

func (r *Label) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Label) XXX_GraphQLIDType

func (r *Label) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Label) XXX_GraphQLType

func (r *Label) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type LabelID

type LabelID string

A unique identifier for an object.

type ListTypeDef

type ListTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a list type in a Module.

func (*ListTypeDef) AsNode

func (r *ListTypeDef) AsNode() Node

AsNode returns this ListTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*ListTypeDef) ElementTypeDef

func (r *ListTypeDef) ElementTypeDef() *TypeDef

The type of the elements in the list.

func (*ListTypeDef) ID

func (r *ListTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this ListTypeDef.

func (*ListTypeDef) MarshalJSON

func (r *ListTypeDef) MarshalJSON() ([]byte, error)

func (*ListTypeDef) WithGraphQLQuery

func (r *ListTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *ListTypeDef

func (*ListTypeDef) XXX_GraphQLID

func (r *ListTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ListTypeDef) XXX_GraphQLIDType

func (r *ListTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ListTypeDef) XXX_GraphQLType

func (r *ListTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ListTypeDefID

type ListTypeDefID string

A unique identifier for an object.

type Loadable

type Loadable[T any] interface {
	Node
	WithGraphQLQuery(*querybuilder.Selection) T
}

Loadable is the constraint for types that can be loaded from an ID. Every generated object and interface client type satisfies this.

type Mise

type Mise struct {
	// contains filtered or unexported fields
}

func (*Mise) AsNode

func (r *Mise) AsNode() Node

AsNode returns this Mise as a Node. This is a local type conversion — no GraphQL call.

func (*Mise) Container

func (r *Mise) Container(opts ...MiseContainerOpts) *Container

func (*Mise) ID

func (r *Mise) ID(ctx context.Context) (ID, error)

A unique identifier for this Mise.

func (*Mise) MarshalJSON

func (r *Mise) MarshalJSON() ([]byte, error)

func (*Mise) WithGraphQLQuery

func (r *Mise) WithGraphQLQuery(q *querybuilder.Selection) *Mise

func (*Mise) XXX_GraphQLID

func (r *Mise) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Mise) XXX_GraphQLIDType

func (r *Mise) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Mise) XXX_GraphQLType

func (r *Mise) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type MiseID

type MiseID string

A unique identifier for an object.

type Module

type Module struct {
	// contains filtered or unexported fields
}

A Dagger module.

func (*Module) AsNode

func (r *Module) AsNode() Node

AsNode returns this Module as a Node. This is a local type conversion — no GraphQL call.

func (*Module) AsSyncer

func (r *Module) AsSyncer() Syncer

AsSyncer returns this Module as a Syncer. This is a local type conversion — no GraphQL call.

func (*Module) Check

func (r *Module) Check(name string) *Check

Return the check defined by the module with the given name. Must match to exactly one check.

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Module) Checks

func (r *Module) Checks(opts ...ModuleChecksOpts) *CheckGroup

Return all checks defined by the module

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Module) Dependencies

func (r *Module) Dependencies(ctx context.Context) ([]Module, error)

The dependencies of the module.

func (*Module) Description

func (r *Module) Description(ctx context.Context) (string, error)

The doc string of the module, if any

func (*Module) Enums

func (r *Module) Enums(ctx context.Context) ([]TypeDef, error)

Enumerations served by this module.

func (*Module) GeneratedContextDirectory

func (r *Module) GeneratedContextDirectory() *Directory

The generated files and directories made on top of the module source's context directory.

func (*Module) Generator

func (r *Module) Generator(name string) *Generator

Return the generator defined by the module with the given name. Must match to exactly one generator.

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Module) Generators

func (r *Module) Generators(opts ...ModuleGeneratorsOpts) *GeneratorGroup

Return all generators defined by the module

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Module) ID

func (r *Module) ID(ctx context.Context) (ID, error)

A unique identifier for this Module.

func (*Module) Interfaces

func (r *Module) Interfaces(ctx context.Context) ([]TypeDef, error)

Interfaces served by this module.

func (*Module) IntrospectionSchemaJSON

func (r *Module) IntrospectionSchemaJSON() *File

The introspection schema JSON file for this module.

This file represents the schema visible to the module's source code, including all core types and those from the dependencies.

Note: this is in the context of a module, so some core types may be hidden.

func (*Module) MarshalJSON

func (r *Module) MarshalJSON() ([]byte, error)

func (*Module) Name

func (r *Module) Name(ctx context.Context) (string, error)

The name of the module

func (*Module) Objects

func (r *Module) Objects(ctx context.Context) ([]TypeDef, error)

Objects served by this module.

func (*Module) Runtime

func (r *Module) Runtime() *Container

The container that runs the module's entrypoint. It will fail to execute if the module doesn't compile.

func (*Module) SDK

func (r *Module) SDK() *SDKConfig

The SDK config used by this module.

func (*Module) Serve

func (r *Module) Serve(ctx context.Context, opts ...ModuleServeOpts) error

Serve a module's API in the current session.

Note: this can only be called once per session. In the future, it could return a stream or service to remove the side effect.

func (*Module) Services

func (r *Module) Services(opts ...ModuleServicesOpts) *UpGroup

Return all services defined by the module

Experimental: This API is highly experimental and may be removed or replaced entirely.

func (*Module) Source

func (r *Module) Source() *ModuleSource

The source for the module.

func (*Module) Sync

func (r *Module) Sync(ctx context.Context) (*Module, error)

Forces evaluation of the module, including any loading into the engine and associated validation.

func (*Module) UserDefaults

func (r *Module) UserDefaults() *EnvFile

User-defined default values, loaded from local .env files.

func (*Module) With

func (r *Module) With(f WithModuleFunc) *Module

With calls the provided function with current Module.

This is useful for reusability and readability by not breaking the calling chain.

func (*Module) WithDescription

func (r *Module) WithDescription(description string) *Module

Retrieves the module with the given description

func (*Module) WithEnum

func (r *Module) WithEnum(enum *TypeDef) *Module

This module plus the given Enum type and associated values

func (*Module) WithGraphQLQuery

func (r *Module) WithGraphQLQuery(q *querybuilder.Selection) *Module

func (*Module) WithInterface

func (r *Module) WithInterface(iface *TypeDef) *Module

This module plus the given Interface type and associated functions

func (*Module) WithObject

func (r *Module) WithObject(object *TypeDef) *Module

This module plus the given Object type and associated functions.

func (*Module) XXX_GraphQLID

func (r *Module) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Module) XXX_GraphQLIDType

func (r *Module) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Module) XXX_GraphQLType

func (r *Module) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ModuleChecksOpts

type ModuleChecksOpts struct {
	// Only include checks matching the specified patterns
	Include []string
	// When true, only return annotated check functions; exclude generate-as-checks
	NoGenerate bool
}

ModuleChecksOpts contains options for Module.Checks

type ModuleConfigClient

type ModuleConfigClient struct {
	// contains filtered or unexported fields
}

The client generated for the module.

func (*ModuleConfigClient) AsNode

func (r *ModuleConfigClient) AsNode() Node

AsNode returns this ModuleConfigClient as a Node. This is a local type conversion — no GraphQL call.

func (*ModuleConfigClient) Directory

func (r *ModuleConfigClient) Directory(ctx context.Context) (string, error)

The directory the client is generated in.

func (*ModuleConfigClient) Generator

func (r *ModuleConfigClient) Generator(ctx context.Context) (string, error)

The generator to use

func (*ModuleConfigClient) ID

func (r *ModuleConfigClient) ID(ctx context.Context) (ID, error)

A unique identifier for this ModuleConfigClient.

func (*ModuleConfigClient) MarshalJSON

func (r *ModuleConfigClient) MarshalJSON() ([]byte, error)

func (*ModuleConfigClient) WithGraphQLQuery

func (*ModuleConfigClient) XXX_GraphQLID

func (r *ModuleConfigClient) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ModuleConfigClient) XXX_GraphQLIDType

func (r *ModuleConfigClient) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ModuleConfigClient) XXX_GraphQLType

func (r *ModuleConfigClient) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ModuleConfigClientID

type ModuleConfigClientID string

A unique identifier for an object.

type ModuleGeneratorsOpts

type ModuleGeneratorsOpts struct {
	// Only include generators matching the specified patterns
	Include []string
}

ModuleGeneratorsOpts contains options for Module.Generators

type ModuleID

type ModuleID string

A unique identifier for an object.

type ModuleServeOpts

type ModuleServeOpts struct {
	// Expose the dependencies of this module to the client
	IncludeDependencies bool
	// Install the module as the entrypoint, promoting its main-object methods onto the Query root
	Entrypoint bool
}

ModuleServeOpts contains options for Module.Serve

type ModuleServicesOpts

type ModuleServicesOpts struct {
	// Only include services matching the specified patterns
	Include []string
}

ModuleServicesOpts contains options for Module.Services

type ModuleSource

type ModuleSource struct {
	// contains filtered or unexported fields
}

The source needed to load and run a module, along with any metadata about the source such as versions/urls/etc.

func (*ModuleSource) AsModule

func (r *ModuleSource) AsModule() *Module

Load the source as a module. If this is a local source, the parent directory must have been provided during module source creation

func (*ModuleSource) AsNode

func (r *ModuleSource) AsNode() Node

AsNode returns this ModuleSource as a Node. This is a local type conversion — no GraphQL call.

func (*ModuleSource) AsString

func (r *ModuleSource) AsString(ctx context.Context) (string, error)

A human readable ref string representation of this module source.

func (*ModuleSource) AsSyncer

func (r *ModuleSource) AsSyncer() Syncer

AsSyncer returns this ModuleSource as a Syncer. This is a local type conversion — no GraphQL call.

func (*ModuleSource) Blueprint

func (r *ModuleSource) Blueprint() *ModuleSource

The blueprint referenced by the module source.

func (*ModuleSource) CloneRef

func (r *ModuleSource) CloneRef(ctx context.Context) (string, error)

The ref to clone the root of the git repo from. Only valid for git sources.

func (*ModuleSource) Commit

func (r *ModuleSource) Commit(ctx context.Context) (string, error)

The resolved commit of the git repo this source points to.

func (*ModuleSource) ConfigClients

func (r *ModuleSource) ConfigClients(ctx context.Context) ([]ModuleConfigClient, error)

The clients generated for the module.

func (*ModuleSource) ConfigExists

func (r *ModuleSource) ConfigExists(ctx context.Context) (bool, error)

Whether an existing dagger.json for the module was found.

func (*ModuleSource) ContextDirectory

func (r *ModuleSource) ContextDirectory() *Directory

The full directory loaded for the module source, including the source code as a subdirectory.

func (*ModuleSource) Dependencies

func (r *ModuleSource) Dependencies(ctx context.Context) ([]ModuleSource, error)

The dependencies of the module source.

func (*ModuleSource) Digest

func (r *ModuleSource) Digest(ctx context.Context) (string, error)

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.

func (*ModuleSource) Directory

func (r *ModuleSource) Directory(path string) *Directory

The directory containing the module configuration and source code (source code may be in a subdir).

func (*ModuleSource) EngineVersion

func (r *ModuleSource) EngineVersion(ctx context.Context) (string, error)

The engine version of the module.

func (*ModuleSource) GeneratedContextChangeset

func (r *ModuleSource) GeneratedContextChangeset() *Changeset

The generated files and directories made on top of the module source's context directory, returned as a Changeset.

func (*ModuleSource) GeneratedContextDirectory

func (r *ModuleSource) GeneratedContextDirectory() *Directory

The generated files and directories made on top of the module source's context directory.

func (*ModuleSource) HTMLRepoURL

func (r *ModuleSource) HTMLRepoURL(ctx context.Context) (string, error)

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket).

func (*ModuleSource) HTMLURL

func (r *ModuleSource) HTMLURL(ctx context.Context) (string, error)

The URL to the source's git repo in a web browser. Only valid for git sources.

func (*ModuleSource) ID

func (r *ModuleSource) ID(ctx context.Context) (ID, error)

A unique identifier for this ModuleSource.

func (*ModuleSource) IntrospectionSchemaJSON

func (r *ModuleSource) IntrospectionSchemaJSON() *File

The introspection schema JSON file for this module source.

This file represents the schema visible to the module's source code, including all core types and those from the dependencies.

Note: this is in the context of a module, so some core types may be hidden.

func (*ModuleSource) Kind

The kind of module source (currently local, git or dir).

func (*ModuleSource) LocalContextDirectoryPath

func (r *ModuleSource) LocalContextDirectoryPath(ctx context.Context) (string, error)

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.

func (*ModuleSource) MarshalJSON

func (r *ModuleSource) MarshalJSON() ([]byte, error)

func (*ModuleSource) ModuleName

func (r *ModuleSource) ModuleName(ctx context.Context) (string, error)

The name of the module, including any setting via the withName API.

func (*ModuleSource) ModuleOriginalName

func (r *ModuleSource) ModuleOriginalName(ctx context.Context) (string, error)

The original name of the module as read from the module's dagger.json (or set for the first time with the withName API).

func (*ModuleSource) OriginalSubpath

func (r *ModuleSource) OriginalSubpath(ctx context.Context) (string, error)

The original subpath used when instantiating this module source, relative to the context directory.

func (*ModuleSource) Pin

func (r *ModuleSource) Pin(ctx context.Context) (string, error)

The pinned version of this module source.

func (*ModuleSource) RepoRootPath

func (r *ModuleSource) RepoRootPath(ctx context.Context) (string, error)

The import path corresponding to the root of the git repo this source points to. Only valid for git sources.

func (*ModuleSource) SDK

func (r *ModuleSource) SDK() *SDKConfig

The SDK configuration of the module.

func (*ModuleSource) SourceRootSubpath

func (r *ModuleSource) SourceRootSubpath(ctx context.Context) (string, error)

The path, relative to the context directory, that contains the module's dagger.json.

func (*ModuleSource) SourceSubpath

func (r *ModuleSource) SourceSubpath(ctx context.Context) (string, error)

The path to the directory containing the module's source code, relative to the context directory.

func (*ModuleSource) Sync

func (r *ModuleSource) Sync(ctx context.Context) (*ModuleSource, error)

Forces evaluation of the module source, including any loading into the engine and associated validation.

func (*ModuleSource) Toolchains

func (r *ModuleSource) Toolchains(ctx context.Context) ([]ModuleSource, error)

The toolchains referenced by the module source.

func (*ModuleSource) UserDefaults

func (r *ModuleSource) UserDefaults() *EnvFile

User-defined defaults read from local .env files

func (*ModuleSource) Version

func (r *ModuleSource) Version(ctx context.Context) (string, error)

The specified version of the git repo this source points to.

func (*ModuleSource) With

With calls the provided function with current ModuleSource.

This is useful for reusability and readability by not breaking the calling chain.

func (*ModuleSource) WithBlueprint

func (r *ModuleSource) WithBlueprint(blueprint *ModuleSource) *ModuleSource

Set a blueprint for the module source.

func (*ModuleSource) WithClient

func (r *ModuleSource) WithClient(generator string, outputDir string) *ModuleSource

Update the module source with a new client to generate.

func (*ModuleSource) WithDependencies

func (r *ModuleSource) WithDependencies(dependencies []*ModuleSource) *ModuleSource

Append the provided dependencies to the module source's dependency list.

func (*ModuleSource) WithEngineVersion

func (r *ModuleSource) WithEngineVersion(version string) *ModuleSource

Upgrade the engine version of the module to the given value.

func (*ModuleSource) WithExperimentalFeatures

func (r *ModuleSource) WithExperimentalFeatures(features []ModuleSourceExperimentalFeature) *ModuleSource

Enable the experimental features for the module source.

func (*ModuleSource) WithGraphQLQuery

func (r *ModuleSource) WithGraphQLQuery(q *querybuilder.Selection) *ModuleSource

func (*ModuleSource) WithIncludes

func (r *ModuleSource) WithIncludes(patterns []string) *ModuleSource

Update the module source with additional include patterns for files+directories from its context that are required for building it

func (*ModuleSource) WithName

func (r *ModuleSource) WithName(name string) *ModuleSource

Update the module source with a new name.

func (*ModuleSource) WithSDK

func (r *ModuleSource) WithSDK(source string) *ModuleSource

Update the module source with a new SDK.

func (*ModuleSource) WithSourceSubpath

func (r *ModuleSource) WithSourceSubpath(path string) *ModuleSource

Update the module source with a new source subpath.

func (*ModuleSource) WithToolchains

func (r *ModuleSource) WithToolchains(toolchains []*ModuleSource) *ModuleSource

Add toolchains to the module source.

func (*ModuleSource) WithUpdateBlueprint

func (r *ModuleSource) WithUpdateBlueprint() *ModuleSource

Update the blueprint module to the latest version.

func (*ModuleSource) WithUpdateDependencies

func (r *ModuleSource) WithUpdateDependencies(dependencies []string) *ModuleSource

Update one or more module dependencies.

func (*ModuleSource) WithUpdateToolchains

func (r *ModuleSource) WithUpdateToolchains(toolchains []string) *ModuleSource

Update one or more toolchains.

func (*ModuleSource) WithUpdatedClients

func (r *ModuleSource) WithUpdatedClients(clients []string) *ModuleSource

Update one or more clients.

func (*ModuleSource) WithoutBlueprint

func (r *ModuleSource) WithoutBlueprint() *ModuleSource

Remove the current blueprint from the module source.

func (*ModuleSource) WithoutClient

func (r *ModuleSource) WithoutClient(path string) *ModuleSource

Remove a client from the module source.

func (*ModuleSource) WithoutDependencies

func (r *ModuleSource) WithoutDependencies(dependencies []string) *ModuleSource

Remove the provided dependencies from the module source's dependency list.

func (*ModuleSource) WithoutExperimentalFeatures

func (r *ModuleSource) WithoutExperimentalFeatures(features []ModuleSourceExperimentalFeature) *ModuleSource

Disable experimental features for the module source.

func (*ModuleSource) WithoutToolchains

func (r *ModuleSource) WithoutToolchains(toolchains []string) *ModuleSource

Remove the provided toolchains from the module source.

func (*ModuleSource) XXX_GraphQLID

func (r *ModuleSource) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ModuleSource) XXX_GraphQLIDType

func (r *ModuleSource) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ModuleSource) XXX_GraphQLType

func (r *ModuleSource) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ModuleSourceExperimentalFeature

type ModuleSourceExperimentalFeature string

Experimental features of a module

const (
	// Self calls
	ModuleSourceExperimentalFeatureSelfCalls ModuleSourceExperimentalFeature = "SELF_CALLS"
)

func (ModuleSourceExperimentalFeature) IsEnum

func (*ModuleSourceExperimentalFeature) MarshalJSON

func (v *ModuleSourceExperimentalFeature) MarshalJSON() ([]byte, error)

func (ModuleSourceExperimentalFeature) Name

func (*ModuleSourceExperimentalFeature) UnmarshalJSON

func (v *ModuleSourceExperimentalFeature) UnmarshalJSON(dt []byte) error

func (ModuleSourceExperimentalFeature) Value

type ModuleSourceID

type ModuleSourceID string

A unique identifier for an object.

type ModuleSourceKind

type ModuleSourceKind string

The kind of module source.

const (
	ModuleSourceKindLocalSource ModuleSourceKind = "LOCAL_SOURCE"
	ModuleSourceKindLocal       ModuleSourceKind = ModuleSourceKindLocalSource

	ModuleSourceKindGitSource ModuleSourceKind = "GIT_SOURCE"
	ModuleSourceKindGit       ModuleSourceKind = ModuleSourceKindGitSource

	ModuleSourceKindDirSource ModuleSourceKind = "DIR_SOURCE"
	ModuleSourceKindDir       ModuleSourceKind = ModuleSourceKindDirSource
)

func (ModuleSourceKind) IsEnum

func (ModuleSourceKind) IsEnum()

func (*ModuleSourceKind) MarshalJSON

func (v *ModuleSourceKind) MarshalJSON() ([]byte, error)

func (ModuleSourceKind) Name

func (v ModuleSourceKind) Name() string

func (*ModuleSourceKind) UnmarshalJSON

func (v *ModuleSourceKind) UnmarshalJSON(dt []byte) error

func (ModuleSourceKind) Value

func (v ModuleSourceKind) Value() string

type ModuleSourceOpts

type ModuleSourceOpts struct {
	// The pinned version of the module source
	RefPin string
	// If true, do not attempt to find dagger.json in a parent directory of the provided path. Only relevant for local module sources.
	DisableFindUp bool
	// If true, do not error out if the provided ref string is a local path and does not exist yet. Useful when initializing new modules in directories that don't exist yet.
	AllowNotExists bool
	// If set, error out if the ref string is not of the provided requireKind.
	RequireKind ModuleSourceKind
}

ModuleSourceOpts contains options for Query.ModuleSource

type NetworkProtocol

type NetworkProtocol string

Transport layer network protocol associated to a port.

const (
	NetworkProtocolTcp NetworkProtocol = "TCP"

	NetworkProtocolUdp NetworkProtocol = "UDP"
)

func (NetworkProtocol) IsEnum

func (NetworkProtocol) IsEnum()

func (*NetworkProtocol) MarshalJSON

func (v *NetworkProtocol) MarshalJSON() ([]byte, error)

func (NetworkProtocol) Name

func (v NetworkProtocol) Name() string

func (*NetworkProtocol) UnmarshalJSON

func (v *NetworkProtocol) UnmarshalJSON(dt []byte) error

func (NetworkProtocol) Value

func (v NetworkProtocol) Value() string

type Node

type Node interface {
	DaggerObject

	ID(ctx context.Context) (ID, error)
}

An object with a globally unique ID.

type NodeClient

type NodeClient struct {
	// contains filtered or unexported fields
}

NodeClient is the query-builder for the Node interface.

func (*NodeClient) ID

func (r *NodeClient) ID(ctx context.Context) (ID, error)

func (*NodeClient) MarshalJSON

func (r *NodeClient) MarshalJSON() ([]byte, error)

func (*NodeClient) WithGraphQLQuery

func (r *NodeClient) WithGraphQLQuery(q *querybuilder.Selection) *NodeClient

func (*NodeClient) XXX_GraphQLID

func (r *NodeClient) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*NodeClient) XXX_GraphQLIDType

func (r *NodeClient) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*NodeClient) XXX_GraphQLType

func (r *NodeClient) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ObjectTypeDef

type ObjectTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a custom object defined in a Module.

func (*ObjectTypeDef) AsNode

func (r *ObjectTypeDef) AsNode() Node

AsNode returns this ObjectTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*ObjectTypeDef) Constructor

func (r *ObjectTypeDef) Constructor() *Function

The function used to construct new instances of this object, if any.

func (*ObjectTypeDef) Deprecated

func (r *ObjectTypeDef) Deprecated(ctx context.Context) (string, error)

The reason this enum member is deprecated, if any.

func (*ObjectTypeDef) Description

func (r *ObjectTypeDef) Description(ctx context.Context) (string, error)

The doc string for the object, if any.

func (*ObjectTypeDef) Fields

func (r *ObjectTypeDef) Fields(ctx context.Context) ([]FieldTypeDef, error)

Static fields defined on this object, if any.

func (*ObjectTypeDef) Functions

func (r *ObjectTypeDef) Functions(ctx context.Context) ([]Function, error)

Functions defined on this object, if any.

func (*ObjectTypeDef) ID

func (r *ObjectTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this ObjectTypeDef.

func (*ObjectTypeDef) MarshalJSON

func (r *ObjectTypeDef) MarshalJSON() ([]byte, error)

func (*ObjectTypeDef) Name

func (r *ObjectTypeDef) Name(ctx context.Context) (string, error)

The name of the object.

func (*ObjectTypeDef) SourceMap

func (r *ObjectTypeDef) SourceMap() *SourceMap

The location of this object declaration.

func (*ObjectTypeDef) SourceModuleName

func (r *ObjectTypeDef) SourceModuleName(ctx context.Context) (string, error)

If this ObjectTypeDef is associated with a Module, the name of the module. Unset otherwise.

func (*ObjectTypeDef) WithGraphQLQuery

func (r *ObjectTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *ObjectTypeDef

func (*ObjectTypeDef) XXX_GraphQLID

func (r *ObjectTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ObjectTypeDef) XXX_GraphQLIDType

func (r *ObjectTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ObjectTypeDef) XXX_GraphQLType

func (r *ObjectTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ObjectTypeDefID

type ObjectTypeDefID string

A unique identifier for an object.

type PipelineLabel

type PipelineLabel struct {
	// Label name.
	Name string `json:"name"`

	// Label value.
	Value string `json:"value"`
}

Key value object that represents a pipeline label.

type Platform

type Platform string

The platform config OS and architecture in a Container.

The format is os/[platform]/[version] (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").

type Port

type Port struct {
	// contains filtered or unexported fields
}

A port exposed by a container.

func (*Port) AsNode

func (r *Port) AsNode() Node

AsNode returns this Port as a Node. This is a local type conversion — no GraphQL call.

func (*Port) Description

func (r *Port) Description(ctx context.Context) (string, error)

The port description.

func (*Port) ExperimentalSkipHealthcheck

func (r *Port) ExperimentalSkipHealthcheck(ctx context.Context) (bool, error)

Skip the health check when run as a service.

func (*Port) ID

func (r *Port) ID(ctx context.Context) (ID, error)

A unique identifier for this Port.

func (*Port) MarshalJSON

func (r *Port) MarshalJSON() ([]byte, error)

func (*Port) Port

func (r *Port) Port(ctx context.Context) (int, error)

The port number.

func (*Port) Protocol

func (r *Port) Protocol(ctx context.Context) (NetworkProtocol, error)

The transport layer protocol.

func (*Port) WithGraphQLQuery

func (r *Port) WithGraphQLQuery(q *querybuilder.Selection) *Port

func (*Port) XXX_GraphQLID

func (r *Port) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Port) XXX_GraphQLIDType

func (r *Port) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Port) XXX_GraphQLType

func (r *Port) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type PortForward

type PortForward struct {
	// Destination port for traffic.
	Backend int `json:"backend"`

	// Port to expose to clients. If unspecified, a default will be chosen.
	Frontend int `json:"frontend"`

	// Transport layer protocol to use for traffic.
	Protocol NetworkProtocol `json:"protocol,omitempty"`
}

Port forwarding rules for tunneling network traffic.

type PortID

type PortID string

A unique identifier for an object.

type Query

type Query struct {
	// contains filtered or unexported fields
}

The root of the DAG.

func (*Query) Address

func (r *Query) Address(value string) *Address

initialize an address to load directories, containers, secrets or other object types.

func (*Query) Arch

func (r *Query) Arch() *Arch

func (*Query) Archive

func (r *Query) Archive(opts ...ArchiveOpts) *Archive

func (*Query) AsNode

func (r *Query) AsNode() Node

AsNode returns this Query as a Node. This is a local type conversion — no GraphQL call.

func (*Query) Binary

func (r *Query) Binary(opts ...BinaryOpts) *File

func (*Query) CacheVolume

func (r *Query) CacheVolume(key string, opts ...CacheVolumeOpts) *CacheVolume

Constructs a cache volume for a given cache key.

func (*Query) Changeset

func (r *Query) Changeset() *Changeset

Creates an empty changeset

func (*Query) Cloud

func (r *Query) Cloud() *Cloud

Dagger Cloud configuration and state

func (*Query) Container

func (r *Query) Container(opts ...ContainerOpts) *Container

func (*Query) CurrentEnv

func (r *Query) CurrentEnv() *Env

Returns the current environment

When called from a function invoked via an LLM tool call, this will be the LLM's current environment, including any modifications made through calling tools. Env values returned by functions become the new environment for subsequent calls, and Changeset values returned by functions are applied to the environment's workspace.

When called from a module function outside of an LLM, this returns an Env with the current module installed, and with the current module's source directory as its workspace.

Experimental: Programmatic env access is speculative and might be replaced.

func (*Query) CurrentFunctionCall

func (r *Query) CurrentFunctionCall() *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 (*Query) CurrentModule

func (r *Query) CurrentModule() *CurrentModule

The module currently being served in the session, if any.

func (*Query) CurrentTypeDefs

func (r *Query) CurrentTypeDefs(ctx context.Context, opts ...CurrentTypeDefsOpts) ([]TypeDef, error)

The TypeDef representations of the objects currently being served in the session.

func (*Query) CurrentWorkspace

func (r *Query) CurrentWorkspace() *Workspace

Detect and return the current workspace.

Experimental: Highly experimental API extracted from a more ambitious workspace implementation.

func (*Query) DefaultPlatform

func (r *Query) DefaultPlatform(ctx context.Context) (Platform, error)

The default platform of the engine.

func (*Query) Directory

func (r *Query) Directory() *Directory

Creates an empty directory.

func (*Query) Engine

func (r *Query) Engine() *Engine

The Dagger engine container configuration and state

func (*Query) Env

func (r *Query) Env(opts ...EnvOpts) *Env

Initializes a new environment

Experimental: Environments are not yet stabilized

func (*Query) EnvFile

func (r *Query) EnvFile(opts ...EnvFileOpts) *EnvFile

Initialize an environment file

func (*Query) Error

func (r *Query) Error(message string) *Error

Create a new error.

func (*Query) File

func (r *Query) File(name string, contents string, opts ...FileOpts) *File

Creates a file with the specified contents.

func (*Query) Function

func (r *Query) Function(name string, returnType *TypeDef) *Function

Creates a function.

func (*Query) GeneratedCode

func (r *Query) GeneratedCode(code *Directory) *GeneratedCode

Create a code generation result, given a directory containing the generated code.

func (*Query) Git

func (r *Query) Git(url string, opts ...GitOpts) *GitRepository

Queries a Git repository.

func (*Query) Go

func (r *Query) Go(opts ...GoOpts) *Go

A generated module for Go functions

func (*Query) HTTP

func (r *Query) HTTP(url string, opts ...HTTPOpts) *File

Returns a file containing an http remote url content.

func (*Query) Host

func (r *Query) Host() *Host

Queries the host environment.

func (*Query) ID

func (r *Query) ID(ctx context.Context) (ID, error)

A unique identifier for this Query.

func (*Query) JSON

func (r *Query) JSON() *JSONValue

Initialize a JSON value

func (*Query) LLM

func (r *Query) LLM(opts ...LLMOpts) *LLM

Initialize a Large Language Model (LLM)

Experimental: LLM support is not yet stabilized

func (*Query) LoadAddressFromID

func (r *Query) LoadAddressFromID(id AddressID) *Address

Load a Address from its ID.

func (*Query) LoadArchFromID

func (r *Query) LoadArchFromID(id ArchID) *Arch

Load a Arch from its ID.

func (*Query) LoadArchiveFromID

func (r *Query) LoadArchiveFromID(id ArchiveID) *Archive

Load a Archive from its ID.

func (*Query) LoadBindingFromID

func (r *Query) LoadBindingFromID(id BindingID) *Binding

Load a Binding from its ID.

func (*Query) LoadCacheVolumeFromID

func (r *Query) LoadCacheVolumeFromID(id CacheVolumeID) *CacheVolume

Load a CacheVolume from its ID.

func (*Query) LoadChangesetFromID

func (r *Query) LoadChangesetFromID(id ChangesetID) *Changeset

Load a Changeset from its ID.

func (*Query) LoadCheckFromID

func (r *Query) LoadCheckFromID(id CheckID) *Check

Load a Check from its ID.

func (*Query) LoadCheckGroupFromID

func (r *Query) LoadCheckGroupFromID(id CheckGroupID) *CheckGroup

Load a CheckGroup from its ID.

func (*Query) LoadClientFilesyncMirrorFromID

func (r *Query) LoadClientFilesyncMirrorFromID(id ClientFilesyncMirrorID) *ClientFilesyncMirror

Load a ClientFilesyncMirror from its ID.

func (*Query) LoadCloudFromID

func (r *Query) LoadCloudFromID(id CloudID) *Cloud

Load a Cloud from its ID.

func (*Query) LoadContainerFromID

func (r *Query) LoadContainerFromID(id ContainerID) *Container

Load a Container from its ID.

func (*Query) LoadCurrentModuleFromID

func (r *Query) LoadCurrentModuleFromID(id CurrentModuleID) *CurrentModule

Load a CurrentModule from its ID.

func (*Query) LoadDiffStatFromID

func (r *Query) LoadDiffStatFromID(id DiffStatID) *DiffStat

Load a DiffStat from its ID.

func (*Query) LoadDirectoryFromID

func (r *Query) LoadDirectoryFromID(id DirectoryID) *Directory

Load a Directory from its ID.

func (*Query) LoadEngineCacheEntryFromID

func (r *Query) LoadEngineCacheEntryFromID(id EngineCacheEntryID) *EngineCacheEntry

Load a EngineCacheEntry from its ID.

func (*Query) LoadEngineCacheEntrySetFromID

func (r *Query) LoadEngineCacheEntrySetFromID(id EngineCacheEntrySetID) *EngineCacheEntrySet

Load a EngineCacheEntrySet from its ID.

func (*Query) LoadEngineCacheFromID

func (r *Query) LoadEngineCacheFromID(id EngineCacheID) *EngineCache

Load a EngineCache from its ID.

func (*Query) LoadEngineFromID

func (r *Query) LoadEngineFromID(id EngineID) *Engine

Load a Engine from its ID.

func (*Query) LoadEnumTypeDefFromID

func (r *Query) LoadEnumTypeDefFromID(id EnumTypeDefID) *EnumTypeDef

Load a EnumTypeDef from its ID.

func (*Query) LoadEnumValueTypeDefFromID

func (r *Query) LoadEnumValueTypeDefFromID(id EnumValueTypeDefID) *EnumValueTypeDef

Load a EnumValueTypeDef from its ID.

func (*Query) LoadEnvFileFromID

func (r *Query) LoadEnvFileFromID(id EnvFileID) *EnvFile

Load a EnvFile from its ID.

func (*Query) LoadEnvFromID

func (r *Query) LoadEnvFromID(id EnvID) *Env

Load a Env from its ID.

func (*Query) LoadEnvVariableFromID

func (r *Query) LoadEnvVariableFromID(id EnvVariableID) *EnvVariable

Load a EnvVariable from its ID.

func (*Query) LoadErrorFromID

func (r *Query) LoadErrorFromID(id ErrorID) *Error

Load a Error from its ID.

func (*Query) LoadErrorValueFromID

func (r *Query) LoadErrorValueFromID(id ErrorValueID) *ErrorValue

Load a ErrorValue from its ID.

func (*Query) LoadExportableFromID

func (r *Query) LoadExportableFromID(id ExportableID) Exportable

Load a Exportable from its ID.

func (*Query) LoadFieldTypeDefFromID

func (r *Query) LoadFieldTypeDefFromID(id FieldTypeDefID) *FieldTypeDef

Load a FieldTypeDef from its ID.

func (*Query) LoadFileFromID

func (r *Query) LoadFileFromID(id FileID) *File

Load a File from its ID.

func (*Query) LoadFunctionArgFromID

func (r *Query) LoadFunctionArgFromID(id FunctionArgID) *FunctionArg

Load a FunctionArg from its ID.

func (*Query) LoadFunctionCallArgValueFromID

func (r *Query) LoadFunctionCallArgValueFromID(id FunctionCallArgValueID) *FunctionCallArgValue

Load a FunctionCallArgValue from its ID.

func (*Query) LoadFunctionCallFromID

func (r *Query) LoadFunctionCallFromID(id FunctionCallID) *FunctionCall

Load a FunctionCall from its ID.

func (*Query) LoadFunctionFromID

func (r *Query) LoadFunctionFromID(id FunctionID) *Function

Load a Function from its ID.

func (*Query) LoadGeneratedCodeFromID

func (r *Query) LoadGeneratedCodeFromID(id GeneratedCodeID) *GeneratedCode

Load a GeneratedCode from its ID.

func (*Query) LoadGeneratorFromID

func (r *Query) LoadGeneratorFromID(id GeneratorID) *Generator

Load a Generator from its ID.

func (*Query) LoadGeneratorGroupFromID

func (r *Query) LoadGeneratorGroupFromID(id GeneratorGroupID) *GeneratorGroup

Load a GeneratorGroup from its ID.

func (*Query) LoadGitRefFromID

func (r *Query) LoadGitRefFromID(id GitRefID) *GitRef

Load a GitRef from its ID.

func (*Query) LoadGitRepositoryFromID

func (r *Query) LoadGitRepositoryFromID(id GitRepositoryID) *GitRepository

Load a GitRepository from its ID.

func (*Query) LoadGoFromID

func (r *Query) LoadGoFromID(id GoID) *Go

Load a Go from its ID.

func (*Query) LoadHTTPStateFromID

func (r *Query) LoadHTTPStateFromID(id HTTPStateID) *HTTPState

Load a HTTPState from its ID.

func (*Query) LoadHealthcheckConfigFromID

func (r *Query) LoadHealthcheckConfigFromID(id HealthcheckConfigID) *HealthcheckConfig

Load a HealthcheckConfig from its ID.

func (*Query) LoadHostFromID

func (r *Query) LoadHostFromID(id HostID) *Host

Load a Host from its ID.

func (*Query) LoadInputTypeDefFromID

func (r *Query) LoadInputTypeDefFromID(id InputTypeDefID) *InputTypeDef

Load a InputTypeDef from its ID.

func (*Query) LoadInterfaceTypeDefFromID

func (r *Query) LoadInterfaceTypeDefFromID(id InterfaceTypeDefID) *InterfaceTypeDef

Load a InterfaceTypeDef from its ID.

func (*Query) LoadJSONValueFromID

func (r *Query) LoadJSONValueFromID(id JSONValueID) *JSONValue

Load a JSONValue from its ID.

func (*Query) LoadLLMFromID

func (r *Query) LoadLLMFromID(id LLMID) *LLM

Load a LLM from its ID.

func (*Query) LoadLLMTokenUsageFromID

func (r *Query) LoadLLMTokenUsageFromID(id LLMTokenUsageID) *LLMTokenUsage

Load a LLMTokenUsage from its ID.

func (*Query) LoadLabelFromID

func (r *Query) LoadLabelFromID(id LabelID) *Label

Load a Label from its ID.

func (*Query) LoadListTypeDefFromID

func (r *Query) LoadListTypeDefFromID(id ListTypeDefID) *ListTypeDef

Load a ListTypeDef from its ID.

func (*Query) LoadMiseFromID

func (r *Query) LoadMiseFromID(id MiseID) *Mise

Load a Mise from its ID.

func (*Query) LoadModuleConfigClientFromID

func (r *Query) LoadModuleConfigClientFromID(id ModuleConfigClientID) *ModuleConfigClient

Load a ModuleConfigClient from its ID.

func (*Query) LoadModuleFromID

func (r *Query) LoadModuleFromID(id ModuleID) *Module

Load a Module from its ID.

func (*Query) LoadModuleSourceFromID

func (r *Query) LoadModuleSourceFromID(id ModuleSourceID) *ModuleSource

Load a ModuleSource from its ID.

func (*Query) LoadObjectTypeDefFromID

func (r *Query) LoadObjectTypeDefFromID(id ObjectTypeDefID) *ObjectTypeDef

Load a ObjectTypeDef from its ID.

func (*Query) LoadPortFromID

func (r *Query) LoadPortFromID(id PortID) *Port

Load a Port from its ID.

func (*Query) LoadRemoteGitMirrorFromID

func (r *Query) LoadRemoteGitMirrorFromID(id RemoteGitMirrorID) *RemoteGitMirror

Load a RemoteGitMirror from its ID.

func (*Query) LoadSDKConfigFromID

func (r *Query) LoadSDKConfigFromID(id SDKConfigID) *SDKConfig

Load a SDKConfig from its ID.

func (*Query) LoadScalarTypeDefFromID

func (r *Query) LoadScalarTypeDefFromID(id ScalarTypeDefID) *ScalarTypeDef

Load a ScalarTypeDef from its ID.

func (*Query) LoadSearchResultFromID

func (r *Query) LoadSearchResultFromID(id SearchResultID) *SearchResult

Load a SearchResult from its ID.

func (*Query) LoadSearchSubmatchFromID

func (r *Query) LoadSearchSubmatchFromID(id SearchSubmatchID) *SearchSubmatch

Load a SearchSubmatch from its ID.

func (*Query) LoadSecretFromID

func (r *Query) LoadSecretFromID(id SecretID) *Secret

Load a Secret from its ID.

func (*Query) LoadServiceFromID

func (r *Query) LoadServiceFromID(id ServiceID) *Service

Load a Service from its ID.

func (*Query) LoadSindriDevFromID

func (r *Query) LoadSindriDevFromID(id SindriDevID) *SindriDev

Load a SindriDev from its ID.

func (*Query) LoadSindriFromID

func (r *Query) LoadSindriFromID(id SindriID) *Sindri

Load a Sindri from its ID.

func (*Query) LoadSocketFromID

func (r *Query) LoadSocketFromID(id SocketID) *Socket

Load a Socket from its ID.

func (*Query) LoadSourceMapFromID

func (r *Query) LoadSourceMapFromID(id SourceMapID) *SourceMap

Load a SourceMap from its ID.

func (*Query) LoadStatFromID

func (r *Query) LoadStatFromID(id StatID) *Stat

Load a Stat from its ID.

func (*Query) LoadSyncerFromID

func (r *Query) LoadSyncerFromID(id SyncerID) Syncer

Load a Syncer from its ID.

func (*Query) LoadTerminalFromID

func (r *Query) LoadTerminalFromID(id TerminalID) *Terminal

Load a Terminal from its ID.

func (*Query) LoadTypeDefFromID

func (r *Query) LoadTypeDefFromID(id TypeDefID) *TypeDef

Load a TypeDef from its ID.

func (*Query) LoadUpFromID

func (r *Query) LoadUpFromID(id UpID) *Up

Load a Up from its ID.

func (*Query) LoadUpGroupFromID

func (r *Query) LoadUpGroupFromID(id UpGroupID) *UpGroup

Load a UpGroup from its ID.

func (*Query) LoadWolfiFromID

func (r *Query) LoadWolfiFromID(id WolfiID) *Wolfi

Load a Wolfi from its ID.

func (*Query) LoadWorkspaceFromID

func (r *Query) LoadWorkspaceFromID(id WorkspaceID) *Workspace

Load a Workspace from its ID.

func (*Query) MarshalJSON

func (r *Query) MarshalJSON() ([]byte, error)

func (*Query) Mise

func (r *Query) Mise(opts ...MiseOpts) *Mise

func (*Query) Module

func (r *Query) Module() *Module

Create a new module.

func (*Query) ModuleSource

func (r *Query) ModuleSource(refString string, opts ...ModuleSourceOpts) *ModuleSource

Create a new module source instance from a source ref string

func (*Query) Node

func (r *Query) Node(id ID) Node

Load any object by its ID.

func (*Query) Secret

func (r *Query) Secret(uri string, opts ...SecretOpts) *Secret

Creates a new secret.

func (*Query) Service

func (r *Query) Service(opts ...ServiceOpts) *Service

func (*Query) SetSecret

func (r *Query) SetSecret(name string, plaintext string) *Secret

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.

func (*Query) Sindri

func (r *Query) Sindri() *Sindri

The interface that a Dagger module must implement to work with Sindri.

func (*Query) SourceMap

func (r *Query) SourceMap(filename string, line int, column int) *SourceMap

Creates source map metadata.

func (*Query) Tag

func (r *Query) Tag(ctx context.Context, opts ...TagOpts) (string, error)

func (*Query) Test

func (r *Query) Test(ctx context.Context, opts ...TestOpts) error

func (*Query) TypeDef

func (r *Query) TypeDef() *TypeDef

Create a new TypeDef.

func (*Query) Version

func (r *Query) Version(ctx context.Context, opts ...VersionOpts) (string, error)

func (*Query) WithGraphQLQuery

func (r *Query) WithGraphQLQuery(q *querybuilder.Selection) *Query

func (*Query) Wolfi

func (r *Query) Wolfi() *Wolfi

A Wolfi Linux configuration

func (*Query) XXX_GraphQLID

func (r *Query) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Query) XXX_GraphQLIDType

func (r *Query) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Query) XXX_GraphQLType

func (r *Query) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type RemoteGitMirror

type RemoteGitMirror struct {
	// contains filtered or unexported fields
}

An internal persistent bare git mirror.

func (*RemoteGitMirror) AsNode

func (r *RemoteGitMirror) AsNode() Node

AsNode returns this RemoteGitMirror as a Node. This is a local type conversion — no GraphQL call.

func (*RemoteGitMirror) ID

func (r *RemoteGitMirror) ID(ctx context.Context) (ID, error)

A unique identifier for this RemoteGitMirror.

func (*RemoteGitMirror) MarshalJSON

func (r *RemoteGitMirror) MarshalJSON() ([]byte, error)

func (*RemoteGitMirror) WithGraphQLQuery

func (r *RemoteGitMirror) WithGraphQLQuery(q *querybuilder.Selection) *RemoteGitMirror

func (*RemoteGitMirror) XXX_GraphQLID

func (r *RemoteGitMirror) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*RemoteGitMirror) XXX_GraphQLIDType

func (r *RemoteGitMirror) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*RemoteGitMirror) XXX_GraphQLType

func (r *RemoteGitMirror) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type RemoteGitMirrorID

type RemoteGitMirrorID string

A unique identifier for an object.

type Request

type Request = dagger.Request

Request contains all the values required to build queries executed by the graphql.Client

type Response

type Response = dagger.Response

Response contains data returned by the GraphQL API

type ReturnType

type ReturnType string

Expected return type of an execution

const (
	// A successful execution (exit code 0)
	ReturnTypeSuccess ReturnType = "SUCCESS"

	// A failed execution (exit codes 1-127 and 192-255)
	ReturnTypeFailure ReturnType = "FAILURE"

	// Any execution (exit codes 0-127 and 192-255)
	ReturnTypeAny ReturnType = "ANY"
)

func (ReturnType) IsEnum

func (ReturnType) IsEnum()

func (*ReturnType) MarshalJSON

func (v *ReturnType) MarshalJSON() ([]byte, error)

func (ReturnType) Name

func (v ReturnType) Name() string

func (*ReturnType) UnmarshalJSON

func (v *ReturnType) UnmarshalJSON(dt []byte) error

func (ReturnType) Value

func (v ReturnType) Value() string

type SDKConfig

type SDKConfig struct {
	// contains filtered or unexported fields
}

The SDK config of the module.

func (*SDKConfig) AsNode

func (r *SDKConfig) AsNode() Node

AsNode returns this SDKConfig as a Node. This is a local type conversion — no GraphQL call.

func (*SDKConfig) Debug

func (r *SDKConfig) Debug(ctx context.Context) (bool, error)

Whether to start the SDK runtime in debug mode with an interactive terminal.

func (*SDKConfig) ID

func (r *SDKConfig) ID(ctx context.Context) (ID, error)

A unique identifier for this SDKConfig.

func (*SDKConfig) MarshalJSON

func (r *SDKConfig) MarshalJSON() ([]byte, error)

func (*SDKConfig) Source

func (r *SDKConfig) Source(ctx context.Context) (string, error)

Source of the SDK. Either a name of a builtin SDK or a module source ref string pointing to the SDK's implementation.

func (*SDKConfig) WithGraphQLQuery

func (r *SDKConfig) WithGraphQLQuery(q *querybuilder.Selection) *SDKConfig

func (*SDKConfig) XXX_GraphQLID

func (r *SDKConfig) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SDKConfig) XXX_GraphQLIDType

func (r *SDKConfig) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SDKConfig) XXX_GraphQLType

func (r *SDKConfig) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SDKConfigID

type SDKConfigID string

A unique identifier for an object.

type ScalarTypeDef

type ScalarTypeDef struct {
	// contains filtered or unexported fields
}

A definition of a custom scalar defined in a Module.

func (*ScalarTypeDef) AsNode

func (r *ScalarTypeDef) AsNode() Node

AsNode returns this ScalarTypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*ScalarTypeDef) Description

func (r *ScalarTypeDef) Description(ctx context.Context) (string, error)

A doc string for the scalar, if any.

func (*ScalarTypeDef) ID

func (r *ScalarTypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this ScalarTypeDef.

func (*ScalarTypeDef) MarshalJSON

func (r *ScalarTypeDef) MarshalJSON() ([]byte, error)

func (*ScalarTypeDef) Name

func (r *ScalarTypeDef) Name(ctx context.Context) (string, error)

The name of the scalar.

func (*ScalarTypeDef) SourceModuleName

func (r *ScalarTypeDef) SourceModuleName(ctx context.Context) (string, error)

If this ScalarTypeDef is associated with a Module, the name of the module. Unset otherwise.

func (*ScalarTypeDef) WithGraphQLQuery

func (r *ScalarTypeDef) WithGraphQLQuery(q *querybuilder.Selection) *ScalarTypeDef

func (*ScalarTypeDef) XXX_GraphQLID

func (r *ScalarTypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*ScalarTypeDef) XXX_GraphQLIDType

func (r *ScalarTypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*ScalarTypeDef) XXX_GraphQLType

func (r *ScalarTypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ScalarTypeDefID

type ScalarTypeDefID string

A unique identifier for an object.

type SearchResult

type SearchResult struct {
	// contains filtered or unexported fields
}

func (*SearchResult) AbsoluteOffset

func (r *SearchResult) AbsoluteOffset(ctx context.Context) (int, error)

The byte offset of this line within the file.

func (*SearchResult) AsNode

func (r *SearchResult) AsNode() Node

AsNode returns this SearchResult as a Node. This is a local type conversion — no GraphQL call.

func (*SearchResult) FilePath

func (r *SearchResult) FilePath(ctx context.Context) (string, error)

The path to the file that matched.

func (*SearchResult) ID

func (r *SearchResult) ID(ctx context.Context) (ID, error)

A unique identifier for this SearchResult.

func (*SearchResult) LineNumber

func (r *SearchResult) LineNumber(ctx context.Context) (int, error)

The first line that matched.

func (*SearchResult) MarshalJSON

func (r *SearchResult) MarshalJSON() ([]byte, error)

func (*SearchResult) MatchedLines

func (r *SearchResult) MatchedLines(ctx context.Context) (string, error)

The line content that matched.

func (*SearchResult) Submatches

func (r *SearchResult) Submatches(ctx context.Context) ([]SearchSubmatch, error)

Sub-match positions and content within the matched lines.

func (*SearchResult) WithGraphQLQuery

func (r *SearchResult) WithGraphQLQuery(q *querybuilder.Selection) *SearchResult

func (*SearchResult) XXX_GraphQLID

func (r *SearchResult) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SearchResult) XXX_GraphQLIDType

func (r *SearchResult) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SearchResult) XXX_GraphQLType

func (r *SearchResult) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SearchResultID

type SearchResultID string

A unique identifier for an object.

type SearchSubmatch

type SearchSubmatch struct {
	// contains filtered or unexported fields
}

func (*SearchSubmatch) AsNode

func (r *SearchSubmatch) AsNode() Node

AsNode returns this SearchSubmatch as a Node. This is a local type conversion — no GraphQL call.

func (*SearchSubmatch) End

func (r *SearchSubmatch) End(ctx context.Context) (int, error)

The match's end offset within the matched lines.

func (*SearchSubmatch) ID

func (r *SearchSubmatch) ID(ctx context.Context) (ID, error)

A unique identifier for this SearchSubmatch.

func (*SearchSubmatch) MarshalJSON

func (r *SearchSubmatch) MarshalJSON() ([]byte, error)

func (*SearchSubmatch) Start

func (r *SearchSubmatch) Start(ctx context.Context) (int, error)

The match's start offset within the matched lines.

func (*SearchSubmatch) Text

func (r *SearchSubmatch) Text(ctx context.Context) (string, error)

The matched text.

func (*SearchSubmatch) WithGraphQLQuery

func (r *SearchSubmatch) WithGraphQLQuery(q *querybuilder.Selection) *SearchSubmatch

func (*SearchSubmatch) XXX_GraphQLID

func (r *SearchSubmatch) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SearchSubmatch) XXX_GraphQLIDType

func (r *SearchSubmatch) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SearchSubmatch) XXX_GraphQLType

func (r *SearchSubmatch) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SearchSubmatchID

type SearchSubmatchID string

A unique identifier for an object.

type Secret

type Secret struct {
	// contains filtered or unexported fields
}

A reference to a secret value, which can be handled more safely than the value itself.

func (*Secret) AsNode

func (r *Secret) AsNode() Node

AsNode returns this Secret as a Node. This is a local type conversion — no GraphQL call.

func (*Secret) ID

func (r *Secret) ID(ctx context.Context) (ID, error)

A unique identifier for this Secret.

func (*Secret) MarshalJSON

func (r *Secret) MarshalJSON() ([]byte, error)

func (*Secret) Name

func (r *Secret) Name(ctx context.Context) (string, error)

The name of this secret.

func (*Secret) Plaintext

func (r *Secret) Plaintext(ctx context.Context) (string, error)

The value of this secret.

func (*Secret) URI

func (r *Secret) URI(ctx context.Context) (string, error)

The URI of this secret.

func (*Secret) WithGraphQLQuery

func (r *Secret) WithGraphQLQuery(q *querybuilder.Selection) *Secret

func (*Secret) XXX_GraphQLID

func (r *Secret) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Secret) XXX_GraphQLIDType

func (r *Secret) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Secret) XXX_GraphQLType

func (r *Secret) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SecretID

type SecretID string

A unique identifier for an object.

type SecretOpts

type SecretOpts struct {
	// If set, the given string will be used as the cache key for this secret. This means that any secrets with the same cache key will be considered equivalent in terms of cache lookups, even if they have different URIs or plaintext values.
	//
	// For example, two secrets with the same cache key provided as secret env vars to other wise equivalent containers will result in the container withExecs hitting the cache for each other.
	//
	// If not set, the cache key for the secret will be derived from its plaintext value as looked up when the secret is constructed.
	CacheKey string
}

SecretOpts contains options for Query.Secret

type Service

type Service struct {
	// contains filtered or unexported fields
}

A content-addressed service providing TCP connectivity.

func (*Service) AsNode

func (r *Service) AsNode() Node

AsNode returns this Service as a Node. This is a local type conversion — no GraphQL call.

func (*Service) AsSyncer

func (r *Service) AsSyncer() Syncer

AsSyncer returns this Service as a Syncer. This is a local type conversion — no GraphQL call.

func (*Service) Endpoint

func (r *Service) Endpoint(ctx context.Context, opts ...ServiceEndpointOpts) (string, error)

Retrieves an endpoint that clients can use to reach this container.

If no port is specified, the first exposed port is used. If none exist an error is returned.

If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.

func (*Service) Hostname

func (r *Service) Hostname(ctx context.Context) (string, error)

Retrieves a hostname which can be used by clients to reach this container.

func (*Service) ID

func (r *Service) ID(ctx context.Context) (ID, error)

A unique identifier for this Service.

func (*Service) MarshalJSON

func (r *Service) MarshalJSON() ([]byte, error)

func (*Service) Ports

func (r *Service) Ports(ctx context.Context) ([]Port, error)

Retrieves the list of ports provided by the service.

func (*Service) Start

func (r *Service) Start(ctx context.Context) (*Service, error)

Start the service and wait for its health checks to succeed.

Services bound to a Container do not need to be manually started.

func (*Service) Stop

func (r *Service) Stop(ctx context.Context, opts ...ServiceStopOpts) (*Service, error)

Stop the service.

func (*Service) Sync

func (r *Service) Sync(ctx context.Context) (*Service, error)

Forces evaluation of the pipeline in the engine.

func (*Service) Terminal

func (r *Service) Terminal(opts ...ServiceTerminalOpts) *Service

func (*Service) Up

func (r *Service) Up(ctx context.Context, opts ...ServiceUpOpts) error

Creates a tunnel that forwards traffic from the caller's network to this service.

func (*Service) With

func (r *Service) With(f WithServiceFunc) *Service

With calls the provided function with current Service.

This is useful for reusability and readability by not breaking the calling chain.

func (*Service) WithGraphQLQuery

func (r *Service) WithGraphQLQuery(q *querybuilder.Selection) *Service

func (*Service) WithHostname

func (r *Service) WithHostname(hostname string) *Service

Configures a hostname which can be used by clients within the session to reach this container.

func (*Service) XXX_GraphQLID

func (r *Service) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Service) XXX_GraphQLIDType

func (r *Service) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Service) XXX_GraphQLType

func (r *Service) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type ServiceEndpointOpts

type ServiceEndpointOpts struct {
	// The exposed port number for the endpoint
	Port int
	// Return a URL with the given scheme, eg. http for http://
	Scheme string
}

ServiceEndpointOpts contains options for Service.Endpoint

type ServiceID

type ServiceID string

A unique identifier for an object.

type ServiceOpts

type ServiceOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:91:2)

	Backend string // sindri-dev (../../.dagger/main.go:93:2)

	Module string // sindri-dev (../../.dagger/main.go:95:2)
}

ServiceOpts contains options for Query.Service

type ServiceStopOpts

type ServiceStopOpts struct {
	// Immediately kill the service without waiting for a graceful exit
	Kill bool
}

ServiceStopOpts contains options for Service.Stop

type ServiceTerminalOpts

type ServiceTerminalOpts struct {
	Cmd []string
}

ServiceTerminalOpts contains options for Service.Terminal

type ServiceUpOpts

type ServiceUpOpts struct {
	// List of frontend/backend port mappings to forward.
	//
	// Frontend is the port accepting traffic on the host, backend is the service port.
	Ports []PortForward
	// Bind each tunnel port to a random port on the host.
	Random bool
}

ServiceUpOpts contains options for Service.Up

type Sindri

type Sindri struct {
	// contains filtered or unexported fields
}

func (*Sindri) AsNode

func (r *Sindri) AsNode() Node

AsNode returns this Sindri as a Node. This is a local type conversion — no GraphQL call.

func (*Sindri) ID

func (r *Sindri) ID(ctx context.Context) (ID, error)

A unique identifier for this Sindri.

func (*Sindri) Image

func (r *Sindri) Image(name string, reference string) *Container

func (*Sindri) MarshalJSON

func (r *Sindri) MarshalJSON() ([]byte, error)

func (*Sindri) WithGraphQLQuery

func (r *Sindri) WithGraphQLQuery(q *querybuilder.Selection) *Sindri

func (*Sindri) XXX_GraphQLID

func (r *Sindri) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Sindri) XXX_GraphQLIDType

func (r *Sindri) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Sindri) XXX_GraphQLType

func (r *Sindri) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SindriDev

type SindriDev struct {
	// contains filtered or unexported fields
}

func (*SindriDev) AsNode

func (r *SindriDev) AsNode() Node

AsNode returns this SindriDev as a Node. This is a local type conversion — no GraphQL call.

func (*SindriDev) Binary

func (r *SindriDev) Binary(opts ...SindriDevBinaryOpts) *File

func (*SindriDev) Container

func (r *SindriDev) Container(opts ...SindriDevContainerOpts) *Container

func (*SindriDev) ID

func (r *SindriDev) ID(ctx context.Context) (ID, error)

A unique identifier for this SindriDev.

func (*SindriDev) MarshalJSON

func (r *SindriDev) MarshalJSON() ([]byte, error)

func (*SindriDev) Service

func (r *SindriDev) Service(opts ...SindriDevServiceOpts) *Service

func (*SindriDev) Tag

func (r *SindriDev) Tag(ctx context.Context, opts ...SindriDevTagOpts) (string, error)

func (*SindriDev) Test

func (r *SindriDev) Test(ctx context.Context, opts ...SindriDevTestOpts) error

func (*SindriDev) Version

func (r *SindriDev) Version(ctx context.Context, opts ...SindriDevVersionOpts) (string, error)

func (*SindriDev) WithGraphQLQuery

func (r *SindriDev) WithGraphQLQuery(q *querybuilder.Selection) *SindriDev

func (*SindriDev) XXX_GraphQLID

func (r *SindriDev) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SindriDev) XXX_GraphQLIDType

func (r *SindriDev) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SindriDev) XXX_GraphQLType

func (r *SindriDev) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SindriDevBinaryOpts

type SindriDevBinaryOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:179:2)
}

SindriDevBinaryOpts contains options for SindriDev.Binary

type SindriDevContainerOpts

type SindriDevContainerOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:32:2)

	Module string // sindri-dev (../../.dagger/main.go:34:2)
}

SindriDevContainerOpts contains options for SindriDev.Container

type SindriDevID

type SindriDevID string

A unique identifier for an object.

type SindriDevServiceOpts

type SindriDevServiceOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:91:2)

	Backend string // sindri-dev (../../.dagger/main.go:93:2)

	Module string // sindri-dev (../../.dagger/main.go:95:2)
}

SindriDevServiceOpts contains options for SindriDev.Service

type SindriDevTagOpts

type SindriDevTagOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:171:2)
}

SindriDevTagOpts contains options for SindriDev.Tag

type SindriDevTestOpts

type SindriDevTestOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:195:2)
}

SindriDevTestOpts contains options for SindriDev.Test

type SindriDevVersionOpts

type SindriDevVersionOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:138:2)
}

SindriDevVersionOpts contains options for SindriDev.Version

type SindriID

type SindriID string

A unique identifier for an object.

type Socket

type Socket struct {
	// contains filtered or unexported fields
}

A Unix or TCP/IP socket that can be mounted into a container.

func (*Socket) AsNode

func (r *Socket) AsNode() Node

AsNode returns this Socket as a Node. This is a local type conversion — no GraphQL call.

func (*Socket) ID

func (r *Socket) ID(ctx context.Context) (ID, error)

A unique identifier for this Socket.

func (*Socket) MarshalJSON

func (r *Socket) MarshalJSON() ([]byte, error)

func (*Socket) WithGraphQLQuery

func (r *Socket) WithGraphQLQuery(q *querybuilder.Selection) *Socket

func (*Socket) XXX_GraphQLID

func (r *Socket) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Socket) XXX_GraphQLIDType

func (r *Socket) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Socket) XXX_GraphQLType

func (r *Socket) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SocketID

type SocketID string

A unique identifier for an object.

type SourceMap

type SourceMap struct {
	// contains filtered or unexported fields
}

Source location information.

func (*SourceMap) AsNode

func (r *SourceMap) AsNode() Node

AsNode returns this SourceMap as a Node. This is a local type conversion — no GraphQL call.

func (*SourceMap) Column

func (r *SourceMap) Column(ctx context.Context) (int, error)

The column number within the line.

func (*SourceMap) Filename

func (r *SourceMap) Filename(ctx context.Context) (string, error)

The filename from the module source.

func (*SourceMap) ID

func (r *SourceMap) ID(ctx context.Context) (ID, error)

A unique identifier for this SourceMap.

func (*SourceMap) Line

func (r *SourceMap) Line(ctx context.Context) (int, error)

The line number within the filename.

func (*SourceMap) MarshalJSON

func (r *SourceMap) MarshalJSON() ([]byte, error)

func (*SourceMap) Module

func (r *SourceMap) Module(ctx context.Context) (string, error)

The module dependency this was declared in.

func (*SourceMap) URL

func (r *SourceMap) URL(ctx context.Context) (string, error)

The URL to the file, if any. This can be used to link to the source map in the browser.

func (*SourceMap) WithGraphQLQuery

func (r *SourceMap) WithGraphQLQuery(q *querybuilder.Selection) *SourceMap

func (*SourceMap) XXX_GraphQLID

func (r *SourceMap) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SourceMap) XXX_GraphQLIDType

func (r *SourceMap) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SourceMap) XXX_GraphQLType

func (r *SourceMap) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SourceMapID

type SourceMapID string

A unique identifier for an object.

type Stat

type Stat struct {
	// contains filtered or unexported fields
}

A file or directory status object.

func (*Stat) AsNode

func (r *Stat) AsNode() Node

AsNode returns this Stat as a Node. This is a local type conversion — no GraphQL call.

func (*Stat) FileType

func (r *Stat) FileType(ctx context.Context) (FileType, error)

file type

func (*Stat) ID

func (r *Stat) ID(ctx context.Context) (ID, error)

A unique identifier for this Stat.

func (*Stat) MarshalJSON

func (r *Stat) MarshalJSON() ([]byte, error)

func (*Stat) Name

func (r *Stat) Name(ctx context.Context) (string, error)

file name

func (*Stat) Permissions

func (r *Stat) Permissions(ctx context.Context) (int, error)

permission bits

func (*Stat) Size

func (r *Stat) Size(ctx context.Context) (int, error)

file size

func (*Stat) WithGraphQLQuery

func (r *Stat) WithGraphQLQuery(q *querybuilder.Selection) *Stat

func (*Stat) XXX_GraphQLID

func (r *Stat) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Stat) XXX_GraphQLIDType

func (r *Stat) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Stat) XXX_GraphQLType

func (r *Stat) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type StatID

type StatID string

A unique identifier for an object.

type Syncer

type Syncer interface {
	DaggerObject

	ID(ctx context.Context) (ID, error)

	Sync(ctx context.Context) (Syncer, error)

	// Concrete loads and returns the underlying concrete type of this
	// interface, which can then be used with a type switch.
	Concrete(ctx context.Context) (Node, error)
}

An object that can be force-evaluated.

Calling sync ensures that the object's entire dependency DAG has been evaluated, returning the object's ID once complete.

type SyncerClient

type SyncerClient struct {
	// contains filtered or unexported fields
}

SyncerClient is the query-builder for the Syncer interface.

func (*SyncerClient) Concrete

func (r *SyncerClient) Concrete(ctx context.Context) (Node, error)

Concrete loads and returns the underlying concrete type of this interface, which can then be used with a type switch.

func (*SyncerClient) ID

func (r *SyncerClient) ID(ctx context.Context) (ID, error)

func (*SyncerClient) MarshalJSON

func (r *SyncerClient) MarshalJSON() ([]byte, error)

func (*SyncerClient) Sync

func (r *SyncerClient) Sync(ctx context.Context) (Syncer, error)

func (*SyncerClient) WithGraphQLQuery

func (r *SyncerClient) WithGraphQLQuery(q *querybuilder.Selection) *SyncerClient

func (*SyncerClient) XXX_GraphQLID

func (r *SyncerClient) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*SyncerClient) XXX_GraphQLIDType

func (r *SyncerClient) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*SyncerClient) XXX_GraphQLType

func (r *SyncerClient) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type SyncerID

type SyncerID string

A unique identifier for an object.

type TagOpts

type TagOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:171:2)
}

TagOpts contains options for Query.Tag

type Terminal

type Terminal struct {
	// contains filtered or unexported fields
}

An interactive terminal that clients can connect to.

func (*Terminal) AsNode

func (r *Terminal) AsNode() Node

AsNode returns this Terminal as a Node. This is a local type conversion — no GraphQL call.

func (*Terminal) AsSyncer

func (r *Terminal) AsSyncer() Syncer

AsSyncer returns this Terminal as a Syncer. This is a local type conversion — no GraphQL call.

func (*Terminal) ID

func (r *Terminal) ID(ctx context.Context) (ID, error)

A unique identifier for this Terminal.

func (*Terminal) MarshalJSON

func (r *Terminal) MarshalJSON() ([]byte, error)

func (*Terminal) Sync

func (r *Terminal) Sync(ctx context.Context) (*Terminal, error)

Forces evaluation of the pipeline in the engine.

It doesn't run the default command if no exec has been set.

func (*Terminal) WithGraphQLQuery

func (r *Terminal) WithGraphQLQuery(q *querybuilder.Selection) *Terminal

func (*Terminal) XXX_GraphQLID

func (r *Terminal) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Terminal) XXX_GraphQLIDType

func (r *Terminal) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Terminal) XXX_GraphQLType

func (r *Terminal) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type TerminalID

type TerminalID string

A unique identifier for an object.

type TestOpts

type TestOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:195:2)
}

TestOpts contains options for Query.Test

type TypeDef

type TypeDef struct {
	// contains filtered or unexported fields
}

A definition of a parameter or return type in a Module.

func (*TypeDef) AsEnum

func (r *TypeDef) AsEnum() *EnumTypeDef

If kind is ENUM, the enum-specific type definition. If kind is not ENUM, this will be null.

func (*TypeDef) AsInput

func (r *TypeDef) AsInput() *InputTypeDef

If kind is INPUT, the input-specific type definition. If kind is not INPUT, this will be null.

func (*TypeDef) AsInterface

func (r *TypeDef) AsInterface() *InterfaceTypeDef

If kind is INTERFACE, the interface-specific type definition. If kind is not INTERFACE, this will be null.

func (*TypeDef) AsList

func (r *TypeDef) AsList() *ListTypeDef

If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.

func (*TypeDef) AsNode

func (r *TypeDef) AsNode() Node

AsNode returns this TypeDef as a Node. This is a local type conversion — no GraphQL call.

func (*TypeDef) AsObject

func (r *TypeDef) AsObject() *ObjectTypeDef

If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

func (*TypeDef) AsScalar

func (r *TypeDef) AsScalar() *ScalarTypeDef

If kind is SCALAR, the scalar-specific type definition. If kind is not SCALAR, this will be null.

func (*TypeDef) ID

func (r *TypeDef) ID(ctx context.Context) (ID, error)

A unique identifier for this TypeDef.

func (*TypeDef) Kind

func (r *TypeDef) Kind(ctx context.Context) (TypeDefKind, error)

The kind of type this is (e.g. primitive, list, object).

func (*TypeDef) MarshalJSON

func (r *TypeDef) MarshalJSON() ([]byte, error)

func (*TypeDef) Name

func (r *TypeDef) Name(ctx context.Context) (string, error)

The canonical non-optional name of the type.

func (*TypeDef) Optional

func (r *TypeDef) Optional(ctx context.Context) (bool, error)

Whether this type can be set to null. Defaults to false.

func (*TypeDef) With

func (r *TypeDef) With(f WithTypeDefFunc) *TypeDef

With calls the provided function with current TypeDef.

This is useful for reusability and readability by not breaking the calling chain.

func (*TypeDef) WithConstructor

func (r *TypeDef) WithConstructor(function *Function) *TypeDef

Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.

func (*TypeDef) WithEnum

func (r *TypeDef) WithEnum(name string, opts ...TypeDefWithEnumOpts) *TypeDef

Returns a TypeDef of kind Enum with the provided name.

Note that an enum's values may be omitted if the intent is only to refer to an enum. This is how functions are able to return their own, or any other circular reference.

func (*TypeDef) WithEnumMember

func (r *TypeDef) WithEnumMember(name string, opts ...TypeDefWithEnumMemberOpts) *TypeDef

Adds a static value for an Enum TypeDef, failing if the type is not an enum.

func (*TypeDef) WithEnumValue deprecated

func (r *TypeDef) WithEnumValue(value string, opts ...TypeDefWithEnumValueOpts) *TypeDef

Adds a static value for an Enum TypeDef, failing if the type is not an enum.

Deprecated: Use WithEnumMember instead

func (*TypeDef) WithField

func (r *TypeDef) WithField(name string, typeDef *TypeDef, opts ...TypeDefWithFieldOpts) *TypeDef

Adds a static field for an Object TypeDef, failing if the type is not an object.

func (*TypeDef) WithFunction

func (r *TypeDef) WithFunction(function *Function) *TypeDef

Adds a function for an Object or Interface TypeDef, failing if the type is not one of those kinds.

func (*TypeDef) WithGraphQLQuery

func (r *TypeDef) WithGraphQLQuery(q *querybuilder.Selection) *TypeDef

func (*TypeDef) WithInterface

func (r *TypeDef) WithInterface(name string, opts ...TypeDefWithInterfaceOpts) *TypeDef

Returns a TypeDef of kind Interface with the provided name.

func (*TypeDef) WithKind

func (r *TypeDef) WithKind(kind TypeDefKind) *TypeDef

Sets the kind of the type.

func (*TypeDef) WithListOf

func (r *TypeDef) WithListOf(elementType *TypeDef) *TypeDef

Returns a TypeDef of kind List with the provided type for its elements.

func (*TypeDef) WithObject

func (r *TypeDef) WithObject(name string, opts ...TypeDefWithObjectOpts) *TypeDef

Returns a TypeDef of kind Object with the provided name.

Note that an object's fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.

func (*TypeDef) WithOptional

func (r *TypeDef) WithOptional(optional bool) *TypeDef

Sets whether this type can be set to null.

func (*TypeDef) WithScalar

func (r *TypeDef) WithScalar(name string, opts ...TypeDefWithScalarOpts) *TypeDef

Returns a TypeDef of kind Scalar with the provided name.

func (*TypeDef) XXX_GraphQLID

func (r *TypeDef) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*TypeDef) XXX_GraphQLIDType

func (r *TypeDef) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*TypeDef) XXX_GraphQLType

func (r *TypeDef) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type TypeDefID

type TypeDefID string

A unique identifier for an object.

type TypeDefKind

type TypeDefKind string

Distinguishes the different kinds of TypeDefs.

const (
	// A string value.
	TypeDefKindStringKind TypeDefKind = "STRING_KIND"
	// A string value.
	TypeDefKindString TypeDefKind = TypeDefKindStringKind

	// An integer value.
	TypeDefKindIntegerKind TypeDefKind = "INTEGER_KIND"
	// An integer value.
	TypeDefKindInteger TypeDefKind = TypeDefKindIntegerKind

	// A float value.
	TypeDefKindFloatKind TypeDefKind = "FLOAT_KIND"
	// A float value.
	TypeDefKindFloat TypeDefKind = TypeDefKindFloatKind

	// A boolean value.
	TypeDefKindBooleanKind TypeDefKind = "BOOLEAN_KIND"
	// A boolean value.
	TypeDefKindBoolean TypeDefKind = TypeDefKindBooleanKind

	// A scalar value of any basic kind.
	TypeDefKindScalarKind TypeDefKind = "SCALAR_KIND"
	// A scalar value of any basic kind.
	TypeDefKindScalar TypeDefKind = TypeDefKindScalarKind

	// Always paired with a ListTypeDef.
	//
	// A list of values all having the same type.
	TypeDefKindListKind TypeDefKind = "LIST_KIND"
	// Always paired with a ListTypeDef.
	//
	// A list of values all having the same type.
	TypeDefKindList TypeDefKind = TypeDefKindListKind

	// Always paired with an ObjectTypeDef.
	//
	// A named type defined in the GraphQL schema, with fields and functions.
	TypeDefKindObjectKind TypeDefKind = "OBJECT_KIND"
	// Always paired with an ObjectTypeDef.
	//
	// A named type defined in the GraphQL schema, with fields and functions.
	TypeDefKindObject TypeDefKind = TypeDefKindObjectKind

	// Always paired with an InterfaceTypeDef.
	//
	// A named type of functions that can be matched+implemented by other objects+interfaces.
	TypeDefKindInterfaceKind TypeDefKind = "INTERFACE_KIND"
	// Always paired with an InterfaceTypeDef.
	//
	// A named type of functions that can be matched+implemented by other objects+interfaces.
	TypeDefKindInterface TypeDefKind = TypeDefKindInterfaceKind

	// A graphql input type, used only when representing the core API via TypeDefs.
	TypeDefKindInputKind TypeDefKind = "INPUT_KIND"
	// A graphql input type, used only when representing the core API via TypeDefs.
	TypeDefKindInput TypeDefKind = TypeDefKindInputKind

	// A special kind used to signify that no value is returned.
	//
	// This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.
	TypeDefKindVoidKind TypeDefKind = "VOID_KIND"
	// A special kind used to signify that no value is returned.
	//
	// This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.
	TypeDefKindVoid TypeDefKind = TypeDefKindVoidKind

	// A GraphQL enum type and its values
	//
	// Always paired with an EnumTypeDef.
	TypeDefKindEnumKind TypeDefKind = "ENUM_KIND"
	// A GraphQL enum type and its values
	//
	// Always paired with an EnumTypeDef.
	TypeDefKindEnum TypeDefKind = TypeDefKindEnumKind
)

func (TypeDefKind) IsEnum

func (TypeDefKind) IsEnum()

func (*TypeDefKind) MarshalJSON

func (v *TypeDefKind) MarshalJSON() ([]byte, error)

func (TypeDefKind) Name

func (v TypeDefKind) Name() string

func (*TypeDefKind) UnmarshalJSON

func (v *TypeDefKind) UnmarshalJSON(dt []byte) error

func (TypeDefKind) Value

func (v TypeDefKind) Value() string

type TypeDefWithEnumMemberOpts

type TypeDefWithEnumMemberOpts struct {
	// The value of the member in the enum
	Value string
	// A doc string for the member, if any
	Description string
	// The source map for the enum member definition.
	SourceMap *SourceMap
	// If deprecated, the reason or migration path.
	Deprecated string
}

TypeDefWithEnumMemberOpts contains options for TypeDef.WithEnumMember

type TypeDefWithEnumOpts

type TypeDefWithEnumOpts struct {
	// A doc string for the enum, if any
	Description string
	// The source map for the enum definition.
	SourceMap *SourceMap
}

TypeDefWithEnumOpts contains options for TypeDef.WithEnum

type TypeDefWithEnumValueOpts

type TypeDefWithEnumValueOpts struct {
	// A doc string for the value, if any
	Description string
	// The source map for the enum value definition.
	SourceMap *SourceMap
	// If deprecated, the reason or migration path.
	Deprecated string
}

TypeDefWithEnumValueOpts contains options for TypeDef.WithEnumValue

type TypeDefWithFieldOpts

type TypeDefWithFieldOpts struct {
	// A doc string for the field, if any
	Description string
	// The source map for the field definition.
	SourceMap *SourceMap
	// If deprecated, the reason or migration path.
	Deprecated string
}

TypeDefWithFieldOpts contains options for TypeDef.WithField

type TypeDefWithInterfaceOpts

type TypeDefWithInterfaceOpts struct {
	Description string

	SourceMap *SourceMap
}

TypeDefWithInterfaceOpts contains options for TypeDef.WithInterface

type TypeDefWithObjectOpts

type TypeDefWithObjectOpts struct {
	Description string

	SourceMap *SourceMap

	Deprecated string
}

TypeDefWithObjectOpts contains options for TypeDef.WithObject

type TypeDefWithScalarOpts

type TypeDefWithScalarOpts struct {
	Description string
}

TypeDefWithScalarOpts contains options for TypeDef.WithScalar

type Up

type Up struct {
	// contains filtered or unexported fields
}

func (*Up) AsNode

func (r *Up) AsNode() Node

AsNode returns this Up as a Node. This is a local type conversion — no GraphQL call.

func (*Up) Description

func (r *Up) Description(ctx context.Context) (string, error)

The description of the service

func (*Up) ID

func (r *Up) ID(ctx context.Context) (ID, error)

A unique identifier for this Up.

func (*Up) MarshalJSON

func (r *Up) MarshalJSON() ([]byte, error)

func (*Up) Name

func (r *Up) Name(ctx context.Context) (string, error)

Return the fully qualified name of the service

func (*Up) OriginalModule

func (r *Up) OriginalModule() *Module

The original module in which the service has been defined

func (*Up) Path

func (r *Up) Path(ctx context.Context) ([]string, error)

The path of the service within its module

func (*Up) Run

func (r *Up) Run() *Up

Execute the service function

func (*Up) With

func (r *Up) With(f WithUpFunc) *Up

With calls the provided function with current Up.

This is useful for reusability and readability by not breaking the calling chain.

func (*Up) WithGraphQLQuery

func (r *Up) WithGraphQLQuery(q *querybuilder.Selection) *Up

func (*Up) XXX_GraphQLID

func (r *Up) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Up) XXX_GraphQLIDType

func (r *Up) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Up) XXX_GraphQLType

func (r *Up) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type UpGroup

type UpGroup struct {
	// contains filtered or unexported fields
}

func (*UpGroup) AsNode

func (r *UpGroup) AsNode() Node

AsNode returns this UpGroup as a Node. This is a local type conversion — no GraphQL call.

func (*UpGroup) ID

func (r *UpGroup) ID(ctx context.Context) (ID, error)

A unique identifier for this UpGroup.

func (*UpGroup) List

func (r *UpGroup) List(ctx context.Context) ([]Up, error)

Return a list of individual services and their details

func (*UpGroup) MarshalJSON

func (r *UpGroup) MarshalJSON() ([]byte, error)

func (*UpGroup) Run

func (r *UpGroup) Run() *UpGroup

Execute all selected service functions

func (*UpGroup) With

func (r *UpGroup) With(f WithUpGroupFunc) *UpGroup

With calls the provided function with current UpGroup.

This is useful for reusability and readability by not breaking the calling chain.

func (*UpGroup) WithGraphQLQuery

func (r *UpGroup) WithGraphQLQuery(q *querybuilder.Selection) *UpGroup

func (*UpGroup) XXX_GraphQLID

func (r *UpGroup) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*UpGroup) XXX_GraphQLIDType

func (r *UpGroup) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*UpGroup) XXX_GraphQLType

func (r *UpGroup) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type UpGroupID

type UpGroupID string

A unique identifier for an object.

type UpID

type UpID string

A unique identifier for an object.

type VersionOpts

type VersionOpts struct {
	Workspace *Workspace // sindri-dev (../../.dagger/main.go:138:2)
}

VersionOpts contains options for Query.Version

type Void

type Void string

The absence of a value.

A Null Void is used as a placeholder for resolvers that do not return anything.

type WithChangesetFunc

type WithChangesetFunc func(r *Changeset) *Changeset

type WithCheckFunc

type WithCheckFunc func(r *Check) *Check

type WithCheckGroupFunc

type WithCheckGroupFunc func(r *CheckGroup) *CheckGroup

type WithContainerFunc

type WithContainerFunc func(r *Container) *Container

type WithDirectoryFunc

type WithDirectoryFunc func(r *Directory) *Directory

type WithEnvFileFunc

type WithEnvFileFunc func(r *EnvFile) *EnvFile

type WithEnvFunc

type WithEnvFunc func(r *Env) *Env

type WithErrorFunc

type WithErrorFunc func(r *Error) *Error

type WithFileFunc

type WithFileFunc func(r *File) *File

type WithFunctionFunc

type WithFunctionFunc func(r *Function) *Function

type WithGeneratedCodeFunc

type WithGeneratedCodeFunc func(r *GeneratedCode) *GeneratedCode

type WithGeneratorFunc

type WithGeneratorFunc func(r *Generator) *Generator

type WithGeneratorGroupFunc

type WithGeneratorGroupFunc func(r *GeneratorGroup) *GeneratorGroup

type WithGitRefFunc

type WithGitRefFunc func(r *GitRef) *GitRef

type WithJSONValueFunc

type WithJSONValueFunc func(r *JSONValue) *JSONValue

type WithLLMFunc

type WithLLMFunc func(r *LLM) *LLM

type WithModuleFunc

type WithModuleFunc func(r *Module) *Module

type WithModuleSourceFunc

type WithModuleSourceFunc func(r *ModuleSource) *ModuleSource

type WithServiceFunc

type WithServiceFunc func(r *Service) *Service

type WithTypeDefFunc

type WithTypeDefFunc func(r *TypeDef) *TypeDef

type WithUpFunc

type WithUpFunc func(r *Up) *Up

type WithUpGroupFunc

type WithUpGroupFunc func(r *UpGroup) *UpGroup

type Wolfi

type Wolfi struct {
	// contains filtered or unexported fields
}

A Wolfi Linux configuration

func (*Wolfi) AsNode

func (r *Wolfi) AsNode() Node

AsNode returns this Wolfi as a Node. This is a local type conversion — no GraphQL call.

func (*Wolfi) Container

func (r *Wolfi) Container(opts ...WolfiContainerOpts) *Container

Build a Wolfi Linux container

func (*Wolfi) ID

func (r *Wolfi) ID(ctx context.Context) (ID, error)

A unique identifier for this Wolfi.

func (*Wolfi) MarshalJSON

func (r *Wolfi) MarshalJSON() ([]byte, error)

func (*Wolfi) WithGraphQLQuery

func (r *Wolfi) WithGraphQLQuery(q *querybuilder.Selection) *Wolfi

func (*Wolfi) XXX_GraphQLID

func (r *Wolfi) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Wolfi) XXX_GraphQLIDType

func (r *Wolfi) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Wolfi) XXX_GraphQLType

func (r *Wolfi) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type WolfiContainerOpts

type WolfiContainerOpts struct {
	//
	// APK packages to install
	//
	Packages []string // wolfi (https://github.com/dagger/dagger/tree/054f94b2d86c0ac00bef11ac4550816973c4aeef/modules/wolfi/main.go#L16)
	//
	// Hardware architecture to target
	//
	Arch string // wolfi (https://github.com/dagger/dagger/tree/054f94b2d86c0ac00bef11ac4550816973c4aeef/modules/wolfi/main.go#L19)
	//
	// Extra repositories to add to the package resolver
	//
	ExtraRepositories []string // wolfi (https://github.com/dagger/dagger/tree/054f94b2d86c0ac00bef11ac4550816973c4aeef/modules/wolfi/main.go#L22)
	//
	// Extra keys needed to authenticate the extra repositories
	//
	ExtraKeyUrls []string // wolfi (https://github.com/dagger/dagger/tree/054f94b2d86c0ac00bef11ac4550816973c4aeef/modules/wolfi/main.go#L25)
	//
	// Overlay images to merge on top of the base.
	// See https://twitter.com/ibuildthecloud/status/1721306361999597884
	//
	Overlays []*Container // wolfi (https://github.com/dagger/dagger/tree/054f94b2d86c0ac00bef11ac4550816973c4aeef/modules/wolfi/main.go#L29)
}

WolfiContainerOpts contains options for Wolfi.Container

type WolfiID

type WolfiID string

A unique identifier for an object.

type Workspace

type Workspace struct {
	// contains filtered or unexported fields
}

A Dagger workspace detected from the current working directory.

func (*Workspace) Address

func (r *Workspace) Address(ctx context.Context) (string, error)

Canonical Dagger address of the workspace directory.

func (*Workspace) AsNode

func (r *Workspace) AsNode() Node

AsNode returns this Workspace as a Node. This is a local type conversion — no GraphQL call.

func (*Workspace) Checks

func (r *Workspace) Checks(opts ...WorkspaceChecksOpts) *CheckGroup

Return all checks from modules loaded in the workspace.

func (*Workspace) ClientID

func (r *Workspace) ClientID(ctx context.Context) (string, error)

The client ID that owns this workspace's host filesystem.

func (*Workspace) ConfigPath

func (r *Workspace) ConfigPath(ctx context.Context) (string, error)

Path to config.toml relative to the workspace boundary (empty if not initialized).

func (*Workspace) Directory

func (r *Workspace) Directory(path string, opts ...WorkspaceDirectoryOpts) *Directory

Returns a Directory from the workspace.

Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

func (*Workspace) File

func (r *Workspace) File(path string) *File

Returns a File from the workspace.

Relative paths resolve from the workspace directory. Absolute paths resolve from the workspace boundary.

func (*Workspace) FindUp

func (r *Workspace) FindUp(ctx context.Context, name string, opts ...WorkspaceFindUpOpts) (string, error)

Search for a file or directory by walking up from the start path within the workspace.

Returns the absolute workspace path if found, or null if not found.

Relative start paths resolve from the workspace directory.

The search stops at the workspace boundary and will not traverse above it.

func (*Workspace) Generators

func (r *Workspace) Generators(opts ...WorkspaceGeneratorsOpts) *GeneratorGroup

Return all generators from modules loaded in the workspace.

func (*Workspace) HasConfig

func (r *Workspace) HasConfig(ctx context.Context) (bool, error)

Whether a config.toml file exists in the workspace.

func (*Workspace) ID

func (r *Workspace) ID(ctx context.Context) (ID, error)

A unique identifier for this Workspace.

func (*Workspace) Initialized

func (r *Workspace) Initialized(ctx context.Context) (bool, error)

Whether .dagger/config.toml exists.

func (*Workspace) MarshalJSON

func (r *Workspace) MarshalJSON() ([]byte, error)

func (*Workspace) Path

func (r *Workspace) Path(ctx context.Context) (string, error)

Workspace directory path relative to the workspace boundary.

func (*Workspace) Services

func (r *Workspace) Services(opts ...WorkspaceServicesOpts) *UpGroup

Return all services from modules loaded in the workspace.

func (*Workspace) Update

func (r *Workspace) Update() *Changeset

Refresh workspace-managed state and return the resulting changeset.

Currently this refreshes existing lockfile entries only.

Experimental: Experimental workspace update API currently refreshes existing lockfile entries only.

func (*Workspace) WithGraphQLQuery

func (r *Workspace) WithGraphQLQuery(q *querybuilder.Selection) *Workspace

func (*Workspace) XXX_GraphQLID

func (r *Workspace) XXX_GraphQLID(ctx context.Context) (string, error)

XXX_GraphQLID is an internal function. It returns the underlying type ID

func (*Workspace) XXX_GraphQLIDType

func (r *Workspace) XXX_GraphQLIDType() string

XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object

func (*Workspace) XXX_GraphQLType

func (r *Workspace) XXX_GraphQLType() string

XXX_GraphQLType is an internal function. It returns the native GraphQL type name

type WorkspaceChecksOpts

type WorkspaceChecksOpts struct {
	// Only include checks matching the specified patterns
	Include []string
	// When true, only return annotated check functions; exclude generate-as-checks
	NoGenerate bool
	// When true, only return generate-as-checks; exclude annotated check functions
	OnlyGenerate bool
}

WorkspaceChecksOpts contains options for Workspace.Checks

type WorkspaceDirectoryOpts

type WorkspaceDirectoryOpts struct {
	// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
	Exclude []string
	// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
	Include []string
	// Apply .gitignore filter rules inside the directory.
	Gitignore bool
}

WorkspaceDirectoryOpts contains options for Workspace.Directory

type WorkspaceFindUpOpts

type WorkspaceFindUpOpts struct {
	// Path to start the search from. Relative paths resolve from the workspace directory; absolute paths resolve from the workspace boundary.
	//
	// Default: "."
	From string
}

WorkspaceFindUpOpts contains options for Workspace.FindUp

type WorkspaceGeneratorsOpts

type WorkspaceGeneratorsOpts struct {
	// Only include generators matching the specified patterns
	Include []string
}

WorkspaceGeneratorsOpts contains options for Workspace.Generators

type WorkspaceID

type WorkspaceID string

A unique identifier for an object.

type WorkspaceServicesOpts

type WorkspaceServicesOpts struct {
	// Only include services matching the specified patterns
	Include []string
}

WorkspaceServicesOpts contains options for Workspace.Services

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL