astarte_flow
astarte_flow v0.1.0

Astarte.Flow.Pipelines.Storage behaviour (astarte_flow v0.1.0)

Link to this section Summary

Callbacks

delete_pipeline(realm, name)
fetch_pipeline(realm, name)
insert_pipeline(realm, pipeline)
list_pipelines(realm)

Link to this section Callbacks

Link to this callback

delete_pipeline(realm, name)

@callback delete_pipeline(realm :: String.t(), name :: String.t()) ::
  :ok | {:error, reason :: term()}
Link to this callback

fetch_pipeline(realm, name)

@callback fetch_pipeline(realm :: String.t(), name :: String.t()) ::
  {:ok, Astarte.Flow.Pipelines.Pipeline.t()} | {:error, reason :: term()}
Link to this callback

insert_pipeline(realm, pipeline)

@callback insert_pipeline(
  realm :: String.t(),
  pipeline :: Astarte.Flow.Pipelines.Pipeline.t()
) :: :ok | {:error, reason :: term()}
Link to this callback

list_pipelines(realm)

@callback list_pipelines(realm :: String.t()) :: [Astarte.Flow.Pipelines.Pipeline.t()]