Scrypath.Operator.Status (scrypath v0.3.0)

Copy Markdown View Source

Public status snapshot returned by Scrypath.sync_status/2.

Summary

Types

backend_section()
section()
t()

Functions

fetch(schema_module, config, operator_opts)
new(attrs)

Types

backend_section()

@type backend_section() :: %{
  pending: [Scrypath.Operator.State.t()],
  failed: [Scrypath.Operator.State.t()],
  last_succeeded: Scrypath.Operator.State.t() | nil
}

section()

@type section() :: %{
  optional(:observed?) => boolean(),
  pending: [Scrypath.Operator.State.t()],
  retrying: [Scrypath.Operator.State.t()],
  failed: [Scrypath.Operator.State.t()],
  last_succeeded: Scrypath.Operator.State.t() | nil
}

t()

@type t() :: %Scrypath.Operator.Status{
  backend: backend_section(),
  index: String.t(),
  mode: :inline | :manual | :oban | atom(),
  queue: section(),
  schema: module()
}

Functions

fetch(schema_module, config, operator_opts)

@spec fetch(module(), keyword(), keyword()) :: {:ok, t()} | {:error, term()}

new(attrs)

@spec new(keyword()) :: t()