antikythera v0.3.0 AntikytheraCore.AsyncJob View Source

Updates an existing instance of AntikytheraCore.AsyncJob 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}.

update!(s, dict)

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

valid?(value)

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

Link to this section Types

t()

t() :: %AntikytheraCore.AsyncJob{
  attempts: Antikythera.AsyncJob.Attempts.t(),
  gear_name: Antikythera.GearName.t(),
  max_duration: Antikythera.AsyncJob.MaxDuration.t(),
  module: Croma.Atom.t(),
  payload: :"Elixir.Croma.TypeGen.Union.6D2FE83728B42D355050F824A49A63B1".t(),
  remaining_attempts: Antikythera.AsyncJob.Attempts.t(),
  retry_interval: Antikythera.AsyncJob.RetryInterval.t(),
  schedule: Antikythera.AsyncJob.Schedule.t()
}

Link to this section Functions

attempts(async_job)

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

Type-aware getter for attempts.

attempts(s, field)

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

Type-aware setter for attempts.

compute_retry_interval(arg0)

compute_retry_interval(AntikytheraCore.AsyncJob.t()) :: non_neg_integer()

gear_name(async_job)

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

Type-aware getter for gear_name.

gear_name(s, field)

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

Type-aware setter for gear_name.

max_duration(async_job)

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

Type-aware getter for max_duration.

max_duration(s, field)

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

Type-aware setter for max_duration.

max_start_time_from_now()

module(async_job)

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

Type-aware getter for module.

module(s, field)

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

Type-aware setter for module.

new(dict)

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

Creates a new instance of AntikytheraCore.AsyncJob 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

new!(dict)

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.

payload(async_job)

payload(t()) ::
  :"Elixir.Croma.TypeGen.Union.6D2FE83728B42D355050F824A49A63B1".t()

Type-aware getter for payload.

payload(s, field)

payload(
  t(),
  :"Elixir.Croma.TypeGen.Union.6D2FE83728B42D355050F824A49A63B1".t()
) :: t()

Type-aware setter for payload.

register(gear_name, module, payload, context_or_epool_id, options)

register(
  Antikythera.GearName.t(),
  module(),
  map(),
  Antikythera.ExecutorPool.Id.t() | Antikythera.Context.t(),
  [option()]
) :: Croma.Result.t(Antikythera.AsyncJob.Id.t())

remaining_attempts(async_job)

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

Type-aware getter for remaining_attempts.

remaining_attempts(s, field)

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

Type-aware setter for remaining_attempts.

retry_interval(async_job)

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

Type-aware getter for retry_interval.

retry_interval(s, field)

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

Type-aware setter for retry_interval.

schedule(async_job)

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

Type-aware getter for schedule.

schedule(s, field)

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

Type-aware setter for schedule.

update(s, dict)

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

update!(s, dict)

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.

valid?(value)

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

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