ExecutionPlane.Target.Client behaviour (execution_plane v0.3.1)

Copy Markdown View Source

Node-to-Target execution client behaviour.

Summary

Callbacks

cancel(t, keyword)
describe(keyword)
execute(t, keyword)
stream(t, keyword)

Callbacks

cancel(t, keyword)

@callback cancel(ExecutionPlane.ExecutionRef.t(), keyword()) :: :ok | {:error, term()}

describe(keyword)

@callback describe(keyword()) :: {:ok, map()} | {:error, term()}

execute(t, keyword)

@callback execute(ExecutionPlane.ExecutionRequest.t(), keyword()) ::
  {:ok, ExecutionPlane.ExecutionResult.t()}
  | {:error, ExecutionPlane.ExecutionResult.t()}

stream(t, keyword)

@callback stream(ExecutionPlane.ExecutionRequest.t(), keyword()) ::
  {:ok, Enumerable.t()} | {:error, ExecutionPlane.Admission.Rejection.t()}