Skip to main content
Version: 1.0-beta

Artifact

API reference​

One workspace value with a complete path and all required dimension keys. Reading metadata does not evaluate the value. Different addresses remain distinct even if they return the same object.

Implements Node

description
The description of the field that supplies this artifact.
directives
The directives carried by this artifact.
id
A unique identifier for this Artifact.
loadError
A module load failure, or an empty string if discovery succeeded.
moduleName
The installed module name.
path
Ordered, literal fields to follow. Entrypoint targets use their shorthand.
uri
The artifact's DAG address, such as dag://engine-dev/playground.
arguments
The arguments accepted by the artifact field.
dimensionKeys
The module name, collection keys, and full path key in the artifact type dimension.
value
Evaluate the target in the workspace that supplied this artifact.

description: String!

The description of the field that supplies this artifact.

directives: [String!]!

The directives carried by this artifact.

id: ID!

A unique identifier for this Artifact.

loadError: String!

A module load failure, or an empty string if discovery succeeded.

moduleName: String!

The installed module name.

path: [String!]!

Ordered, literal fields to follow. Entrypoint targets use their shorthand.

uri(absolute: Boolean = false,dimensionKeys: Boolean = true,typeAssertion: Boolean = false): String!

The artifact's DAG address, such as dag://engine-dev/playground.

absolute: Boolean = false

Prefix the workspace's Git address and commit: dag://<workspace>@<commit>:<path>. Fails if the workspace has no Git address.

dimensionKeys: Boolean = true

Include the dimension keys as a query. Without them, the address is a path selector.

typeAssertion: Boolean = false

Include the artifact type in the scheme: dag+container://.

arguments: [FunctionArg!]!

The arguments accepted by the artifact field.

dimensionKeys: [ArtifactDimensionKey!]!

The module name, collection keys, and full path key in the artifact type dimension.

value(arguments: JSON! = "{}"): Node!

Evaluate the target in the workspace that supplied this artifact.

arguments: JSON! = "{}"

Field arguments as a JSON object.

References

Returned by

ArtifactResult.artifactArtifacts.dimensionItemsArtifacts.itemsArtifacts.one