@type t() :: %Spear.Scavenge{
  id: String.t(),
  result: :Started | :InProgress | :Stopped
}

The result of starting or stopping a scavenge

This structure does not represent the current status of a scavenge. The scavenge stream (Spear.scavenge_stream/1) may be read to determine the current status of a scavenge.

examples

Examples

iex> {:ok, scavenge} = Spear.start_scavenge(conn)
{:ok,
 %Spear.Scavenge{id: "d2897ba8-2f0c-4fc4-bb25-798ba75f3562", result: :Started}}