preservica-client-root
API
Generated with
preservica-client-root/uk.gov.nationalarchives.dp.client/WorkflowClient

WorkflowClient

uk.gov.nationalarchives.dp.client.WorkflowClient
See theWorkflowClient companion trait
object WorkflowClient

An object containing a method which returns an implementation of the WorkflowClient trait

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class Parameter(key: String, value: String)

A workflow request parameter

A workflow request parameter

Value parameters

key

The parameter key

value

The parameter value

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StartWorkflowRequest(workflowContextName: Option[String], workflowContextId: Option[Int], parameters: List[Parameter], correlationId: Option[String])

A workflow request

A workflow request

Value parameters

correlationId

An optional correlation id. This can be empty.

parameters

An list of parameters. This can be empty

workflowContextId

An optional workflow context id. Either this or the context name must be provided.

workflowContextName

An optional workflow context name. Either this or the context id must be provided

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def createWorkflowClient[F[_], S](clientConfig: ClientConfig[F, S])(using me: MonadError[F, Throwable], sync: Sync[F]): WorkflowClient[F]

Creates a new WorkflowClient instance.

Creates a new WorkflowClient instance.

Type parameters

F

The type of the effect

S

The type of the Stream to be used for the streaming methods.

Value parameters

clientConfig

Configuration parameters needed to create the client

me

An implicit instance of cats.MonadError

sync

An implicit instance of cats.Sync

Attributes

Returns

A new WorkflowClient

Generated with