antikythera v0.1.0 AntikytheraCore.AsyncJob 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 max_duration
Type-aware setter for max_duration
Type-aware getter for module
Type-aware setter for module
Creates a new instance of AntikytheraCore.AsyncJob 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
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}
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
t() :: %AntikytheraCore.AsyncJob{attempts: Antikythera.AsyncJob.Attempts.t(), gear_name: Antikythera.GearName.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()}
Link to this section Functions
attempts(t()) :: Antikythera.AsyncJob.Attempts.t()
Type-aware getter for attempts.
attempts(t(), Antikythera.AsyncJob.Attempts.t()) :: t()
Type-aware setter for attempts.
compute_retry_interval(AntikytheraCore.AsyncJob.t()) :: non_neg_integer()
Type-aware getter for gear_name.
gear_name(t(), Antikythera.GearName.t()) :: t()
Type-aware setter for gear_name.
max_duration(t()) :: Antikythera.AsyncJob.MaxDuration.t()
Type-aware getter for max_duration.
max_duration(t(), Antikythera.AsyncJob.MaxDuration.t()) :: t()
Type-aware setter for max_duration.
Type-aware getter for module.
Type-aware setter for module.
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/0of each field typenew/1of 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.
Type-aware getter for payload.
Type-aware setter for payload.
register(Antikythera.GearName.t(), module(), map(), Antikythera.ExecutorPool.Id.t() | Antikythera.Context.t(), [option()]) :: Croma.Result.t(Antikythera.AsyncJob.Id.t())
remaining_attempts(t()) :: Antikythera.AsyncJob.Attempts.t()
Type-aware getter for remaining_attempts.
remaining_attempts(t(), Antikythera.AsyncJob.Attempts.t()) :: t()
Type-aware setter for remaining_attempts.
retry_interval(t()) :: Antikythera.AsyncJob.RetryInterval.t()
Type-aware getter for retry_interval.
retry_interval(t(), Antikythera.AsyncJob.RetryInterval.t()) :: t()
Type-aware setter for retry_interval.
schedule(t()) :: Antikythera.AsyncJob.Schedule.t()
Type-aware getter for schedule.
schedule(t(), Antikythera.AsyncJob.Schedule.t()) :: t()
Type-aware setter for schedule.
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}.
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.