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

EntityClient

uk.gov.nationalarchives.dp.client.EntityClient
See theEntityClient companion trait
object EntityClient

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

Attributes

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

Members list

Type members

Classlikes

case class AddEntityRequest(ref: Option[UUID], title: String, description: Option[String], entityType: EntityType, securityTag: SecurityTag, parentRef: Option[UUID])

Represents an entity to add to Preservica

Represents an entity to add to Preservica

Value parameters

description

The optional description of the new entity

entityType

The type of the new entity

parentRef

An optional parent reference

ref

An optional ref. If one is not provided, one will be generated

securityTag

The security tag of the new entity

title

The title of the new entity

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EntityMetadata(entityNode: Node, identifiersNode: Node, metadataContainerNode: Seq[Node])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum EntityType(val entityPath: String, val entityTypeShort: String)

Represents an entity type

Represents an entity type

Attributes

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

Attributes

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

Represents a Preservica representation tag

Represents a Preservica representation tag

Attributes

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

Represents a Preservica security tag

Represents a Preservica security tag

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SecurityTag

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class UpdateEntityRequest(ref: UUID, title: String, descriptionToChange: Option[String], entityType: EntityType, securityTag: SecurityTag, parentRef: Option[UUID])

Represents an entity to update in Preservica

Represents an entity to update in Preservica

Value parameters

descriptionToChange

The optional description of the updated entity

entityType

The type of the updated entity

parentRef

An optional parent reference

ref

The ref of the entity to be updated

securityTag

The security tag of the updated entity

title

The title of the updated entity

Attributes

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

Value members

Concrete methods

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

Creates a new EntityClient instance.

Creates a new EntityClient 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

Generated with