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 object
trait ProcessMonitorClient[F[_]]

A client to retrieve Preservica Monitors

Type parameters

F

Type of the effect

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def getMessages(getMessagesRequest: GetMessagesRequest, start: Int, max: Int): F[Seq[Message]]

Gets Preservica messages

Gets Preservica messages

Value parameters

getMessagesRequest

An instance of ProcessMonitorClient.getMessages It contains details used to get Messages

max

The maximum number of messages that should be returned (1000 is optimal, more than that could cause issues).

start

The message number to start at.

Attributes

Returns

The Messages requested, wrapped in the F effect.

def getMonitors(getMonitorsRequest: GetMonitorsRequest): F[Seq[Monitors]]

Gets Preservica monitors

Gets Preservica monitors

Value parameters

getMonitorsRequest

An instance of ProcessMonitorClient.getMonitors It contains details used to get Monitors

Attributes

Returns

The Monitors requested, wrapped in the F effect.

Generated with