antikythera v0.2.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

Link to this section Functions

Type-aware getter for attempts.

Type-aware setter for attempts.

Type-aware getter for gear_name.

Link to this function gear_name(s, field) View Source
gear_name(t(), Antikythera.GearName.t()) :: t()

Type-aware setter for gear_name.

Type-aware getter for id.

Type-aware setter for id.

Type-aware getter for max_duration.

Link to this function max_duration(s, field) View Source
max_duration(t(), Antikythera.AsyncJob.MaxDuration.t()) :: t()

Type-aware setter for max_duration.

Type-aware getter for module.

Link to this function module(s, field) View Source
module(t(), Croma.Atom.t()) :: t()

Type-aware setter for module.

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

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

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

Link to this function payload(status) View Source
payload(t()) :: Croma.Map.t()

Type-aware getter for payload.

Link to this function payload(s, field) View Source
payload(t(), Croma.Map.t()) :: t()

Type-aware setter for payload.

Link to this function remaining_attempts(status) View Source
remaining_attempts(t()) :: Antikythera.AsyncJob.Attempts.t()

Type-aware getter for remaining_attempts.

Link to this function remaining_attempts(s, field) View Source
remaining_attempts(t(), Antikythera.AsyncJob.Attempts.t()) :: t()

Type-aware setter for remaining_attempts.

Type-aware getter for retry_interval.

Link to this function retry_interval(s, field) View Source
retry_interval(t(), Antikythera.AsyncJob.RetryInterval.t()) :: t()

Type-aware setter for retry_interval.

Type-aware getter for schedule.

Type-aware setter for schedule.

Link to this function start_time(status) View Source
start_time(t()) :: Antikythera.Time.t()

Type-aware getter for start_time.

Link to this function start_time(s, field) View Source
start_time(t(), Antikythera.Time.t()) :: t()

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}.

Link to this function update!(s, dict) View Source
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.

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