Jidoka.Effect.OperationRequest (Jidoka v0.8.0-beta.1)

Copy Markdown View Source

Typed request payload for an operation effect.

Operation effects are still interpreted by runtime capabilities, but this struct defines the durable data shape those capabilities receive.

Summary

Types

t()

Functions

from_input(request)
new(attrs)
new!(attrs)
schema()
to_payload(request)

Types

t()

@type t() :: %Jidoka.Effect.OperationRequest{
  arguments: map(),
  loop_index: integer(),
  metadata: map(),
  name: binary(),
  request_id: nil | nil | binary()
}

Functions

from_input(request)

@spec from_input(t() | keyword() | map()) :: {:ok, t()} | {:error, term()}

new(attrs)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

new!(attrs)

@spec new!(keyword() | map()) :: t()

schema()

@spec schema() :: Zoi.schema()

to_payload(request)

@spec to_payload(t()) :: map()