Skip to main content

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.

id: ID!

A unique identifier for this Address.

value: String!

The address value

container: Container!

Load a container from the address.

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

Load a directory from the address.

exclude: [String!] = []
include: [String!] = []
gitignore: Boolean = false
noCache: Boolean = false

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

Load a file from the address.

exclude: [String!] = []
include: [String!] = []
gitignore: Boolean = false
noCache: Boolean = false

gitRef: GitRef!

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

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.

References

Returned by

Binding.asAddressQuery.address

Accepted as an argument by

Env.withAddressInput (value)