Address

API reference

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

Implements Node

id

A unique identifier for this Address.

value

The address value

container

Load a container from the address.

directory

Load a directory from the address.

file

Load a file from the address.

gitRef

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

gitRepository

Load a git repository from the address.

secret

Load a secret from the address.

service

Load a service from the address.

socket

Load a local socket from the address.

volume

Load a volume from the address.

workspace

Load a workspace from a module reference.

id: ID!

A unique identifier for this Address.

value: String!

The address value

container(noLock: Boolean = false): Container!

Load a container from the address.

noLock: Boolean = false

Resolve the address's image tag live, ignoring the workspace lockfile: neither read a pinned value nor record one.

A DAG address is unaffected: its module evaluates as usual.

directory(exclude: [String!] = [],include: [String!] = [],gitignore: Boolean = false,noCache: Boolean = false,noLock: Boolean = false): Directory!

Load a directory from the address.

exclude: [String!] = []

include: [String!] = []

gitignore: Boolean = false

noCache: Boolean = false

noLock: Boolean = false

Resolve the address's git ref live, ignoring the workspace lockfile: neither read a pinned value nor record one.

A DAG address is unaffected: its module evaluates as usual.

file(exclude: [String!] = [],include: [String!] = [],gitignore: Boolean = false,noCache: Boolean = false,noLock: Boolean = false): File!

Load a file from the address.

exclude: [String!] = []

include: [String!] = []

gitignore: Boolean = false

noCache: Boolean = false

noLock: Boolean = false

Resolve the address's git ref live, ignoring the workspace lockfile: neither read a pinned value nor record one.

A DAG address is unaffected: its module evaluates as usual.

gitRef(noLock: Boolean = false): GitRef!

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

noLock: Boolean = false

Resolve the address's git ref live, ignoring the workspace lockfile: neither read a pinned value nor record one.

A DAG address is unaffected: its module evaluates as usual.

gitRepository: GitRepository!

Load a git repository from the address.

secret: Secret!

Load a secret from the address.

service: Service!

Load a service from the address.

socket: Socket!

Load a local socket from the address.

volume: Volume!

Load a volume from the address.

workspace: Workspace!

Load a workspace from a module reference.

References

Returned by

Query.addressWorkspace.resolve