aion_client - v0.1.0

aion_client

Caller-side SDK for aion-server workflow operations.

Types

CancelOptions

</> 
pub type CancelOptions {
  CancelOptions(
    workflow_id: String,
    run_id: option.Option(String),
    reason: String,
  )
}

Constructors 

  • CancelOptions(
  workflow_id: String,
  run_id: option.Option(String),
  reason: String,
)

CancelRequest

</> 
pub type CancelRequest {
  CancelRequest(options: CancelOptions)
}

Constructors

Client

</> 
pub type Client {
  Client(config: Config, transport: Transport)
}

Constructors

Config

</> 
pub type Config {
  Config(
    endpoint: String,
    bearer_token: option.Option(String),
    namespace: String,
    tls: Bool,
  )
}

Constructors 

  • Config(
  endpoint: String,
  bearer_token: option.Option(String),
  namespace: String,
  tls: Bool,
)

DescribeOptions

</> 
pub type DescribeOptions {
  DescribeOptions(
    workflow_id: String,
    run_id: option.Option(String),
  )
}

Constructors 

  • DescribeOptions(
  workflow_id: String,
  run_id: option.Option(String),
)

DescribeRequest

</> 
pub type DescribeRequest {
  DescribeRequest(options: DescribeOptions)
}

Constructors

ListOptions

</> 
pub type ListOptions {
  ListOptions(namespace: option.Option(String))
}

Constructors

ListRequest

</> 
pub type ListRequest {
  ListRequest(options: ListOptions)
}

Constructors

QueryOptions

</> 
pub type QueryOptions {
  QueryOptions(
    workflow_id: String,
    run_id: option.Option(String),
    query_name: String,
  )
}

Constructors 

  • QueryOptions(
  workflow_id: String,
  run_id: option.Option(String),
  query_name: String,
)

QueryRequest

</> 
pub type QueryRequest {
  QueryRequest(options: QueryOptions, args: payload.Payload)
}

Constructors

SignalOptions

</> 
pub type SignalOptions {
  SignalOptions(
    workflow_id: String,
    run_id: option.Option(String),
    signal_name: String,
  )
}

Constructors 

  • SignalOptions(
  workflow_id: String,
  run_id: option.Option(String),
  signal_name: String,
)

SignalRequest

</> 
pub type SignalRequest {
  SignalRequest(options: SignalOptions, input: payload.Payload)
}

Constructors

StartOptions

</> 
pub type StartOptions {
  StartOptions(
    workflow_id: String,
    workflow_type: String,
    task_queue: String,
    idempotency_key: option.Option(String),
  )
}

Constructors 

  • StartOptions(
  workflow_id: String,
  workflow_type: String,
  task_queue: String,
  idempotency_key: option.Option(String),
)

StartRequest

</> 
pub type StartRequest {
  StartRequest(options: StartOptions, input: payload.Payload)
}

Constructors

StartResponse

</> 
pub type StartResponse {
  StartResponse(workflow_id: String, run_id: String)
}

Constructors 

  • StartResponse(workflow_id: String, run_id: String)

Transport

</> 
pub type Transport {
  Transport(
    start: fn(Config, StartRequest) -> Result(
      StartResponse,
      error.Error,
    ),
    signal: fn(Config, SignalRequest) -> Result(Nil, error.Error),
    query: fn(Config, QueryRequest) -> Result(
      payload.Payload,
      error.Error,
    ),
    cancel: fn(Config, CancelRequest) -> Result(Nil, error.Error),
    list: fn(Config, ListRequest) -> Result(
      List(WorkflowSummary),
      error.Error,
    ),
    describe: fn(Config, DescribeRequest) -> Result(
      WorkflowDescription,
      error.Error,
    ),
  )
}

Constructors

WorkflowDescription

</> 
pub type WorkflowDescription {
  WorkflowDescription(
    workflow_id: String,
    run_id: String,
    workflow_type: String,
    status: String,
  )
}

Constructors 

  • WorkflowDescription(
  workflow_id: String,
  run_id: String,
  workflow_type: String,
  status: String,
)

WorkflowHandle

</> 
pub type WorkflowHandle {
  WorkflowHandle(
    client: Client,
    workflow_id: String,
    run_id: String,
  )
}

Constructors 

  • WorkflowHandle(
  client: Client,
  workflow_id: String,
  run_id: String,
)

WorkflowSummary

</> 
pub type WorkflowSummary {
  WorkflowSummary(
    workflow_id: String,
    run_id: String,
    workflow_type: String,
    status: String,
  )
}

Constructors 

  • WorkflowSummary(
  workflow_id: String,
  run_id: String,
  workflow_type: String,
  status: String,
)

Values

cancel

</> 
pub fn cancel(
  client: Client,
  options: CancelOptions,
) -> Result(Nil, error.Error)

connect

</> 
pub fn connect(config: Config) -> Result(Client, error.Error)

Connect once to an aion-server deployment. The current implementation stores validated connection configuration and reuses it for all operations; concrete transport failures surface as operation Results, preserving branchable errors.

default_list_options

</> 
pub fn default_list_options(config: Config) -> ListOptions

describe

</> 
pub fn describe(
  client: Client,
  options: DescribeOptions,
) -> Result(WorkflowDescription, error.Error)

latest_run

</> 
pub fn latest_run(
  run_id: option.Option(String),
  default_run_id: String,
) -> String

list

</> 
pub fn list(
  client: Client,
  options: ListOptions,
) -> Result(List(WorkflowSummary), error.Error)

query

</> 
pub fn query(
  client: Client,
  options: QueryOptions,
  args: args,
  encoder: fn(args) -> json.Json,
  decoder: decode.Decoder(result),
) -> Result(result, error.Error)

query_payload

</> 
pub fn query_payload(
  client: Client,
  options: QueryOptions,
  args: payload.Payload,
) -> Result(payload.Payload, error.Error)

query_raw

</> 
pub fn query_raw(
  client: Client,
  options: QueryOptions,
  args: payload.Payload,
  decoder: decode.Decoder(result),
) -> Result(result, error.Error)

signal

</> 
pub fn signal(
  client: Client,
  options: SignalOptions,
  input: input,
  encoder: fn(input) -> json.Json,
) -> Result(Nil, error.Error)

signal_raw

</> 
pub fn signal_raw(
  client: Client,
  options: SignalOptions,
  input: payload.Payload,
) -> Result(Nil, error.Error)

start

</> 
pub fn start(
  client: Client,
  options: StartOptions,
  input: input,
  encoder: fn(input) -> json.Json,
) -> Result(WorkflowHandle, error.Error)

start_raw

</> 
pub fn start_raw(
  client: Client,
  options: StartOptions,
  input: payload.Payload,
) -> Result(WorkflowHandle, error.Error)

with_transport

</> 
pub fn with_transport(
  config: Config,
  transport: Transport,
) -> Result(Client, error.Error)

Test/conformance hook for injecting an HTTP/WebSocket transport while keeping the public SDK semantics identical.

workflow_ids

</> 
pub fn workflow_ids(
  summaries: List(WorkflowSummary),
) -> List(String)
✨ Search Document