AdaSdk.Jobs (ada_sdk v0.0.1)

Copy Markdown View Source

Summary

Functions

event_names()
get_accounting(principal, request)
get_latest_by_document(principal, request)
get_status(principal, request)
on_finished(principal, handler)
on_progressed(principal, handler)
on_started(principal, handler)

Functions

event_names()

@spec event_names() :: [atom()]

get_accounting(principal, request)

@spec get_accounting(AdaSdk.Principal.t(), Ada.V1.GetIngestAccountingRequest.t()) ::
  {:ok, Ada.V1.GetIngestAccountingResponse.t()} | {:error, term()}

get_latest_by_document(principal, request)

@spec get_latest_by_document(
  AdaSdk.Principal.t(),
  Ada.V1.GetLatestJobByDocumentRequest.t()
) :: {:ok, Ada.V1.GetJobStatusResponse.t()} | {:error, term()}

get_status(principal, request)

@spec get_status(AdaSdk.Principal.t(), Ada.V1.GetJobStatusRequest.t()) ::
  {:ok, Ada.V1.GetJobStatusResponse.t()} | {:error, term()}

on_finished(principal, handler)

@spec on_finished(AdaSdk.Principal.t(), (Ada.V1.JobFinished.t() -> term())) ::
  {:ok, AdaSdk.StreamHub.unsubscribe()} | {:error, :closed | :invalid_handler}

on_progressed(principal, handler)

@spec on_progressed(AdaSdk.Principal.t(), (Ada.V1.JobProgressed.t() -> term())) ::
  {:ok, AdaSdk.StreamHub.unsubscribe()} | {:error, :closed | :invalid_handler}

on_started(principal, handler)

@spec on_started(AdaSdk.Principal.t(), (Ada.V1.JobStarted.t() -> term())) ::
  {:ok, AdaSdk.StreamHub.unsubscribe()} | {:error, :closed | :invalid_handler}