View Source Dagger.EnumTypeDef (dagger v0.13.6)

A definition of a custom enum defined in a Module.

Summary

Functions

A doc string for the enum, if any.

A unique identifier for this EnumTypeDef.

The name of the enum.

If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.

The values of the enum.

Types

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

Functions

Link to this function

description(enum_type_def)

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

A doc string for the enum, if any.

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

A unique identifier for this EnumTypeDef.

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

The name of the enum.

Link to this function

source_module_name(enum_type_def)

View Source
@spec source_module_name(t()) :: {:ok, String.t()} | {:error, term()}

If this EnumTypeDef is associated with a Module, the name of the module. Unset otherwise.

@spec values(t()) :: {:ok, [Dagger.EnumValueTypeDef.t()]} | {:error, term()}

The values of the enum.