Spear.stop_scavenge
You're seeing just the function
stop_scavenge
, go back to Spear module for more information.
Specs
stop_scavenge( connection :: Spear.Connection.t(), scavenge_id :: String.t(), opts :: Keyword.t() ) :: {:ok, Spear.Scavenge.t()} | {:error, any()}
Stops a running scavenge
Options
All options are passed to request/5
.
Examples
iex> {:ok, scavenge} = Spear.start_scavenge(conn)
iex> Spear.stop_scavenge(conn, scavenge.id)
{:ok,
%Spear.Scavenge{id: "d2897ba8-2f0c-4fc4-bb25-798ba75f3562", result: :Stopped}}