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

ProcessMonitorClient

uk.gov.nationalarchives.dp.client.ProcessMonitorClient
See theProcessMonitorClient companion trait
object ProcessMonitorClient

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

Attributes

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

Members list

Type members

Classlikes

case class GetMessagesRequest(monitor: List[String], status: List[MessageStatus])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GetMonitorsRequest(status: List[MonitorsStatus], name: Option[String], category: List[MonitorCategory])

A Monitors' request

A Monitors' request

Value parameters

category

A list of categories. This can be empty

name

An optional monitor name.

status

An optional monitor status.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Message(workflowInstanceId: Int, monitorName: String, path: String, date: String, status: String, displayMessage: String, workflowName: String, mappedMonitorId: String, message: String, mappedId: String, securityDescriptor: Option[String], entityTitle: Option[String], entityRef: Option[String], sourceId: Option[String])

Attributes

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

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MessagesResponse(success: Boolean, version: Int, value: MessagesValue)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MessagesValue(paging: Paging, messages: Seq[Message])

Attributes

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

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Monitors(mappedId: String, name: String, status: String, started: Option[String], completed: Option[String], category: String, subcategory: String, progressText: Option[String], percentComplete: Option[String], filesPending: Int, size: Int, filesProcessed: Int, warnings: Int, errors: Int, canRetry: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MonitorsResponse(success: Boolean, version: Int, value: MonitorsValue)

Attributes

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

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MonitorsValue(paging: Paging, monitors: Seq[Monitors])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Paging(next: Option[String], totalResults: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Parameter(key: String, value: String)

A Monitors request parameter

A Monitors 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

Value members

Concrete methods

def createProcessMonitorClient[F[_]](clientConfig: ClientConfig[F, _])(using me: MonadError[F, Throwable], sync: Sync[F]): ProcessMonitorClient[F]

Creates a new ProcessMonitorClient instance.

Creates a new ProcessMonitorClient instance.

Type parameters

F

The type of the effect

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 ProcessMonitorClient

Generated with