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

uk.gov.nationalarchives.dp.client

package uk.gov.nationalarchives.dp.client

Members list

Type members

Classlikes

trait AdminClient[F[_]]

A client to update schemas, transfers, index definitions and metadata templates in Preservica

A client to update schemas, transfers, index definitions and metadata templates in Preservica

Type parameters

F

Type of the effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object AdminClient

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

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object Client

Case classes common to several clients

Case classes common to several clients

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Client.type
trait ContentClient[F[_]]

A client to search for entities in Preservica

A client to search for entities in Preservica

Type parameters

F

Type of the effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ContentClient

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

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class DataProcessor[F[_]]()(using me: MonadError[F, Throwable])

A class to process XML responses from Preservica

A class to process XML responses from Preservica

Type parameters

F

The effect type

Value parameters

me

An implicit MonadError instance

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object DataProcessor

An apply method for the DataProcessor class and the EventAction case class

An apply method for the DataProcessor class and the EventAction case class

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object Entities

The Entity case class with helper methods.

The Entity case class with helper methods.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Entities.type
trait EntityClient[F[_], S]

A client to create, get and update entities in Preservica

A client to create, get and update entities in Preservica

Type parameters

F

Type of the effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object EntityClient

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

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

Attributes

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

Represents a generic XML schema document The specific schema documents are represented in the object

Represents a generic XML schema document The specific schema documents are represented in the object

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FileInfo

This contains implementations of the FileInfo trait

This contains implementations of the FileInfo trait

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
FileInfo.type
class PreservicaClientException(message: String, err: Throwable) extends Exception

A custom exception to represent an error from Preservica

A custom exception to represent an error from Preservica

Value parameters

err

The cause of the exception

message

The exception message

Attributes

Companion
object
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object PreservicaClientException

Custom apply methods for the exception class

Custom apply methods for the exception class

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait ProcessMonitorClient[F[_]]

A client to retrieve Preservica Monitors

A client to retrieve Preservica Monitors

Type parameters

F

Type of the effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ProcessMonitorClient

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

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait WorkflowClient[F[_]]

A client to start a Preservica workflow

A client to start a Preservica workflow

Type parameters

F

Type of the effect

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object WorkflowClient

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

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with