View Source Agens.Job.Sub (agens v0.2.0)

Describes a sub-Job to be started in place of a Serving call on a Job Node.

A Sub is returned from the Agens.Backend.sub/1 callback and carries the configuration and run identifiers needed to nest a Job inside a parent Job.

Fields

  • :config - The Agens.Job.Config defining the sub-Job to run.
  • :run_id - The unique run identifier of the sub-Job instance.
  • :parent_run_id - The run identifier of the enclosing parent Job. Set by the runtime.
  • :parent_node_message - The Agens.Message of the parent Node that triggered the sub-Job. Set by the runtime.

Summary

Types

@type t() :: %Agens.Job.Sub{
  config: Agens.Job.Config.t(),
  parent_node_message: Agens.Message.t() | nil,
  parent_run_id: binary() | nil,
  run_id: binary()
}