View Source Dagger.ObjectTypeDef (dagger v0.10.0)

A definition of a custom object defined in a Module.

Link to this section Summary

Functions

The function used to construct new instances of this object, if any

The doc string for the object, if any.

Static fields defined on this object, if any.

Functions defined on this object, if any.

A unique identifier for this ObjectTypeDef.

The name of the object.

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

Link to this section Types

@type t() :: %Dagger.ObjectTypeDef{client: term(), selection: term()}

Link to this section Functions

Link to this function

constructor(object_type_def)

View Source
@spec constructor(t()) :: {:ok, Dagger.Function.t() | nil} | {:error, term()}

The function used to construct new instances of this object, if any

Link to this function

description(object_type_def)

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

The doc string for the object, if any.

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

Static fields defined on this object, if any.

Link to this function

functions(object_type_def)

View Source
@spec functions(t()) :: {:ok, [Dagger.Function.t()]} | {:error, term()}

Functions defined on this object, if any.

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

A unique identifier for this ObjectTypeDef.

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

The name of the object.

Link to this function

source_module_name(object_type_def)

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

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