FerricStore.SDK.Flow (ferricstore_sdk v0.2.1)

Copy Markdown View Source

Native FerricStore Flow commands.

Functions accept the native typed-map payload documented by the protocol. Id-addressed payloads are routed to the relevant shard leader; keyless aggregate commands use the control connection.

Summary

Functions

approval_approve(client, payload \\ %{}, opts \\ [])
approval_get(client, payload \\ %{}, opts \\ [])
approval_list(client, payload \\ %{}, opts \\ [])
approval_reject(client, payload \\ %{}, opts \\ [])
approval_request(client, payload \\ %{}, opts \\ [])
attribute_values(client, payload \\ %{}, opts \\ [])
attributes(client, payload \\ %{}, opts \\ [])
budget_commit(client, payload \\ %{}, opts \\ [])
budget_get(client, payload \\ %{}, opts \\ [])
budget_list(client, payload \\ %{}, opts \\ [])
budget_release(client, payload \\ %{}, opts \\ [])
budget_reserve(client, payload \\ %{}, opts \\ [])
by_correlation(client, payload \\ %{}, opts \\ [])
by_parent(client, payload \\ %{}, opts \\ [])
by_root(client, payload \\ %{}, opts \\ [])
cancel(client, payload \\ %{}, opts \\ [])
cancel_many(client, payload \\ %{}, opts \\ [])
circuit_close(client, payload \\ %{}, opts \\ [])
circuit_get(client, payload \\ %{}, opts \\ [])
circuit_open(client, payload \\ %{}, opts \\ [])
claim_due(client, payload \\ %{}, opts \\ [])
complete(client, payload \\ %{}, opts \\ [])
complete_many(client, payload \\ %{}, opts \\ [])
create(client, payload \\ %{}, opts \\ [])
create_many(client, payload \\ %{}, opts \\ [])
effect_compensate(client, payload \\ %{}, opts \\ [])
effect_confirm(client, payload \\ %{}, opts \\ [])
effect_fail(client, payload \\ %{}, opts \\ [])
effect_get(client, payload \\ %{}, opts \\ [])
effect_reserve(client, payload \\ %{}, opts \\ [])
extend_lease(client, payload \\ %{}, opts \\ [])
fail(client, payload \\ %{}, opts \\ [])
fail_many(client, payload \\ %{}, opts \\ [])
failures(client, payload \\ %{}, opts \\ [])
get(client, payload \\ %{}, opts \\ [])
governance_ledger(client, payload \\ %{}, opts \\ [])
governance_overview(client, payload \\ %{}, opts \\ [])
history(client, payload \\ %{}, opts \\ [])
info(client, payload \\ %{}, opts \\ [])
limit_get(client, payload \\ %{}, opts \\ [])
limit_lease(client, payload \\ %{}, opts \\ [])
limit_list(client, payload \\ %{}, opts \\ [])
limit_release(client, payload \\ %{}, opts \\ [])
limit_spend(client, payload \\ %{}, opts \\ [])
list(client, payload \\ %{}, opts \\ [])
opcodes()
policy_get(client, payload \\ %{}, opts \\ [])
policy_set(client, payload \\ %{}, opts \\ [])
reclaim(client, payload \\ %{}, opts \\ [])
request(client, opcode, payload, opts \\ [])
retention_cleanup(client, payload \\ %{}, opts \\ [])
retry(client, payload \\ %{}, opts \\ [])
retry_many(client, payload \\ %{}, opts \\ [])
rewind(client, payload \\ %{}, opts \\ [])
run_steps_many(client, payload \\ %{}, opts \\ [])
schedule_create(client, payload \\ %{}, opts \\ [])
schedule_delete(client, payload \\ %{}, opts \\ [])
schedule_fire(client, payload \\ %{}, opts \\ [])
schedule_fire_due(client, payload \\ %{}, opts \\ [])
schedule_get(client, payload \\ %{}, opts \\ [])
schedule_list(client, payload \\ %{}, opts \\ [])
schedule_pause(client, payload \\ %{}, opts \\ [])
schedule_resume(client, payload \\ %{}, opts \\ [])
search(client, payload \\ %{}, opts \\ [])
signal(client, payload \\ %{}, opts \\ [])
spawn_children(client, payload \\ %{}, opts \\ [])
start_and_claim(client, payload \\ %{}, opts \\ [])
stats(client, payload \\ %{}, opts \\ [])
step_continue(client, payload \\ %{}, opts \\ [])
stuck(client, payload \\ %{}, opts \\ [])
terminals(client, payload \\ %{}, opts \\ [])
transition(client, payload \\ %{}, opts \\ [])
transition_many(client, payload \\ %{}, opts \\ [])
value_mget(client, payload \\ %{}, opts \\ [])
value_put(client, payload \\ %{}, opts \\ [])

Functions

approval_approve(client, payload \\ %{}, opts \\ [])

approval_get(client, payload \\ %{}, opts \\ [])

approval_list(client, payload \\ %{}, opts \\ [])

approval_reject(client, payload \\ %{}, opts \\ [])

approval_request(client, payload \\ %{}, opts \\ [])

attribute_values(client, payload \\ %{}, opts \\ [])

attributes(client, payload \\ %{}, opts \\ [])

budget_commit(client, payload \\ %{}, opts \\ [])

budget_get(client, payload \\ %{}, opts \\ [])

budget_list(client, payload \\ %{}, opts \\ [])

budget_release(client, payload \\ %{}, opts \\ [])

budget_reserve(client, payload \\ %{}, opts \\ [])

by_correlation(client, payload \\ %{}, opts \\ [])

by_parent(client, payload \\ %{}, opts \\ [])

by_root(client, payload \\ %{}, opts \\ [])

cancel(client, payload \\ %{}, opts \\ [])

cancel_many(client, payload \\ %{}, opts \\ [])

circuit_close(client, payload \\ %{}, opts \\ [])

circuit_get(client, payload \\ %{}, opts \\ [])

circuit_open(client, payload \\ %{}, opts \\ [])

claim_due(client, payload \\ %{}, opts \\ [])

complete(client, payload \\ %{}, opts \\ [])

complete_many(client, payload \\ %{}, opts \\ [])

create(client, payload \\ %{}, opts \\ [])

create_many(client, payload \\ %{}, opts \\ [])

effect_compensate(client, payload \\ %{}, opts \\ [])

effect_confirm(client, payload \\ %{}, opts \\ [])

effect_fail(client, payload \\ %{}, opts \\ [])

effect_get(client, payload \\ %{}, opts \\ [])

effect_reserve(client, payload \\ %{}, opts \\ [])

extend_lease(client, payload \\ %{}, opts \\ [])

fail(client, payload \\ %{}, opts \\ [])

fail_many(client, payload \\ %{}, opts \\ [])

failures(client, payload \\ %{}, opts \\ [])

get(client, payload \\ %{}, opts \\ [])

governance_ledger(client, payload \\ %{}, opts \\ [])

governance_overview(client, payload \\ %{}, opts \\ [])

history(client, payload \\ %{}, opts \\ [])

info(client, payload \\ %{}, opts \\ [])

limit_get(client, payload \\ %{}, opts \\ [])

limit_lease(client, payload \\ %{}, opts \\ [])

limit_list(client, payload \\ %{}, opts \\ [])

limit_release(client, payload \\ %{}, opts \\ [])

limit_spend(client, payload \\ %{}, opts \\ [])

list(client, payload \\ %{}, opts \\ [])

opcodes()

@spec opcodes() :: map()

policy_get(client, payload \\ %{}, opts \\ [])

policy_set(client, payload \\ %{}, opts \\ [])

reclaim(client, payload \\ %{}, opts \\ [])

request(client, opcode, payload, opts \\ [])

@spec request(
  GenServer.server(),
  non_neg_integer() | atom() | binary(),
  map(),
  keyword()
) ::
  {:ok, term()} | {:error, term()}

retention_cleanup(client, payload \\ %{}, opts \\ [])

retry(client, payload \\ %{}, opts \\ [])

retry_many(client, payload \\ %{}, opts \\ [])

rewind(client, payload \\ %{}, opts \\ [])

run_steps_many(client, payload \\ %{}, opts \\ [])

schedule_create(client, payload \\ %{}, opts \\ [])

schedule_delete(client, payload \\ %{}, opts \\ [])

schedule_fire(client, payload \\ %{}, opts \\ [])

schedule_fire_due(client, payload \\ %{}, opts \\ [])

schedule_get(client, payload \\ %{}, opts \\ [])

schedule_list(client, payload \\ %{}, opts \\ [])

schedule_pause(client, payload \\ %{}, opts \\ [])

schedule_resume(client, payload \\ %{}, opts \\ [])

search(client, payload \\ %{}, opts \\ [])

signal(client, payload \\ %{}, opts \\ [])

spawn_children(client, payload \\ %{}, opts \\ [])

start_and_claim(client, payload \\ %{}, opts \\ [])

stats(client, payload \\ %{}, opts \\ [])

step_continue(client, payload \\ %{}, opts \\ [])

stuck(client, payload \\ %{}, opts \\ [])

terminals(client, payload \\ %{}, opts \\ [])

transition(client, payload \\ %{}, opts \\ [])

transition_many(client, payload \\ %{}, opts \\ [])

value_mget(client, payload \\ %{}, opts \\ [])

value_put(client, payload \\ %{}, opts \\ [])