Dagger.ArtifactDimension (dagger v1.0.0-beta.18)

Copy Markdown View Source

Dagger.ArtifactDimension

Summary

Functions

The collection type, or null for a static dimension.

A unique identifier for this ArtifactDimension.

Stable identifier: collection schema path, type:TypeName for an artifact type, or module.

The collection item or artifact type name, or empty for the module dimension.

The collection key argument description, or empty for a static dimension.

The collection key argument name, or name for a static dimension.

How this dimension gets its keys.

Short name used to select this dimension.

Qualified name used when the short name is ambiguous.

Types

t()

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

Functions

collection_type(artifact_dimension)

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

The collection type, or null for a static dimension.

id(artifact_dimension)

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

A unique identifier for this ArtifactDimension.

identifier(artifact_dimension)

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

Stable identifier: collection schema path, type:TypeName for an artifact type, or module.

item_type(artifact_dimension)

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

The collection item or artifact type name, or empty for the module dimension.

key_description(artifact_dimension)

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

The collection key argument description, or empty for a static dimension.

key_name(artifact_dimension)

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

The collection key argument name, or name for a static dimension.

kind(artifact_dimension)

@spec kind(t()) :: {:ok, Dagger.ArtifactDimensionKind.t()} | {:error, term()}

How this dimension gets its keys.

name(artifact_dimension)

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

Short name used to select this dimension.

qualified_name(artifact_dimension)

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

Qualified name used when the short name is ambiguous.