Dagger.ArtifactPath (dagger v1.0.0-beta.19)

Copy Markdown View Source

A schema path and its dimensions. The path can exist even when its collections have no runtime items.

Summary

Types

t()

Functions

description(artifact_path)

The description of the field at this path.

dimensions(artifact_path)

The dimension identifiers required by this path.

id(artifact_path)

A unique identifier for this ArtifactPath.

load_error(artifact_path)

A module load failure for this path, or an empty string.

module_name(artifact_path)

The installed module name.

uri(artifact_path)

The DAG address of this path, without dimension keys.

Types

t()

@type t() :: %Dagger.ArtifactPath{client: term(), query_builder: term()}

Functions

description(artifact_path)

@spec description(t()) :: {:ok, String.t()} | {:error, term()}

The description of the field at this path.

dimensions(artifact_path)

@spec dimensions(t()) :: {:ok, [String.t()]} | {:error, term()}

The dimension identifiers required by this path.

id(artifact_path)

@spec id(t()) :: {:ok, String.t()} | {:error, term()}

A unique identifier for this ArtifactPath.

load_error(artifact_path)

@spec load_error(t()) :: {:ok, String.t()} | {:error, term()}

A module load failure for this path, or an empty string.

module_name(artifact_path)

@spec module_name(t()) :: {:ok, String.t()} | {:error, term()}

The installed module name.

uri(artifact_path)

@spec uri(t()) :: {:ok, String.t()} | {:error, term()}

The DAG address of this path, without dimension keys.