HostKit.Apply.Event (host_kit v0.1.0-beta.0)

Copy Markdown View Source

Lifecycle message emitted by HostKit apply when a reporter process is configured.

Summary

Types

t()

@type t() :: %HostKit.Apply.Event{
  action: atom() | nil,
  at: DateTime.t(),
  change: HostKit.Change.t() | nil,
  details: map(),
  lifecycle: map() | nil,
  reason: term() | nil,
  resource_id: term(),
  result: map() | nil,
  type: type()
}

type()

@type type() ::
  :apply_started
  | :apply_finished
  | :change_started
  | :change_finished
  | :change_skipped
  | :change_failed
  | :readiness_started
  | :readiness_waiting
  | :readiness_passed
  | :readiness_failed
  | :service_restart_started
  | :service_restart_finished
  | :service_active
  | :service_failed
  | :health_check_started
  | :health_check_waiting
  | :health_check_passed
  | :health_check_failed

Functions

format(event)

@spec format(t()) :: String.t()

new(type, attrs \\ [])

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