antikythera v0.4.0 Antikythera.AsyncJob.Status View Source

Link to this section Summary

Functions

Type-aware getter for attempts.

Type-aware setter for attempts.

Type-aware getter for gear_name.

Type-aware setter for gear_name.

Type-aware getter for id.

Type-aware setter for id.

Type-aware getter for max_duration.

Type-aware setter for max_duration.

Type-aware getter for module.

Type-aware setter for module.

Creates a new instance of Antikythera.AsyncJob.Status by using the given dict.

A variant of new/1 which returns t or raise if validation fails.

Type-aware getter for payload.

Type-aware setter for payload.

Type-aware getter for remaining_attempts.

Type-aware setter for remaining_attempts.

Type-aware getter for retry_interval.

Type-aware setter for retry_interval.

Type-aware getter for schedule.

Type-aware setter for schedule.

Type-aware getter for start_time.

Type-aware setter for start_time.

Type-aware getter for state.

Type-aware setter for state.

Updates an existing instance of Antikythera.AsyncJob.Status with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Checks if the given value belongs to t/0 or not.

Link to this section Types

Specs

t() :: %Antikythera.AsyncJob.Status{
  attempts: Antikythera.AsyncJob.Attempts.t(),
  gear_name: Antikythera.GearName.t(),
  id: Antikythera.AsyncJob.Id.t(),
  max_duration: Antikythera.AsyncJob.MaxDuration.t(),
  module: Croma.Atom.t(),
  payload: Croma.Map.t(),
  remaining_attempts: Antikythera.AsyncJob.Attempts.t(),
  retry_interval: Antikythera.AsyncJob.RetryInterval.t(),
  schedule: Antikythera.AsyncJob.Schedule.t(),
  start_time: Antikythera.Time.t(),
  state: Antikythera.AsyncJob.StateLabel.t()
}

Link to this section Functions

Specs

Type-aware getter for attempts.

Specs

attempts(t(), Antikythera.AsyncJob.Attempts.t()) :: t()

Type-aware setter for attempts.

Specs

gear_name(t()) :: Antikythera.GearName.t()

Type-aware getter for gear_name.

Specs

gear_name(t(), Antikythera.GearName.t()) :: t()

Type-aware setter for gear_name.

Specs

Type-aware getter for id.

Specs

id(t(), Antikythera.AsyncJob.Id.t()) :: t()

Type-aware setter for id.

Specs

max_duration(t()) :: Antikythera.AsyncJob.MaxDuration.t()

Type-aware getter for max_duration.

Specs

max_duration(t(), Antikythera.AsyncJob.MaxDuration.t()) :: t()

Type-aware setter for max_duration.

Specs

module(t()) :: Croma.Atom.t()

Type-aware getter for module.

Specs

module(t(), Croma.Atom.t()) :: t()

Type-aware setter for module.

Specs

new(term()) :: Croma.Result.t(t())

Creates a new instance of Antikythera.AsyncJob.Status by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input

Specs

new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Specs

payload(t()) :: Croma.Map.t()

Type-aware getter for payload.

Specs

payload(t(), Croma.Map.t()) :: t()

Type-aware setter for payload.

Link to this function

remaining_attempts(status)

View Source

Specs

remaining_attempts(t()) :: Antikythera.AsyncJob.Attempts.t()

Type-aware getter for remaining_attempts.

Link to this function

remaining_attempts(s, field)

View Source

Specs

remaining_attempts(t(), Antikythera.AsyncJob.Attempts.t()) :: t()

Type-aware setter for remaining_attempts.

Specs

retry_interval(t()) :: Antikythera.AsyncJob.RetryInterval.t()

Type-aware getter for retry_interval.

Link to this function

retry_interval(s, field)

View Source

Specs

retry_interval(t(), Antikythera.AsyncJob.RetryInterval.t()) :: t()

Type-aware setter for retry_interval.

Specs

Type-aware getter for schedule.

Specs

schedule(t(), Antikythera.AsyncJob.Schedule.t()) :: t()

Type-aware setter for schedule.

Specs

start_time(t()) :: Antikythera.Time.t()

Type-aware getter for start_time.

Specs

start_time(t(), Antikythera.Time.t()) :: t()

Type-aware setter for start_time.

Specs

Type-aware getter for state.

Specs

Type-aware setter for state.

Specs

update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of Antikythera.AsyncJob.Status with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Specs

update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Specs

valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.