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

ContentClient

uk.gov.nationalarchives.dp.client.ContentClient
See theContentClient companion trait
object ContentClient

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

Attributes

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

Members list

Type members

Classlikes

case class SearchField(name: String, values: List[String])

Represents a field to be returned by the search query

Represents a field to be returned by the search query

Value parameters

name

The name of the field

values

The values to be returned. This is not used but is needed by Preservica

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SearchQuery(q: String, fields: List[SearchField])

Represents a complete search request

Represents a complete search request

Value parameters

fields

A list of SearchField

q

A string containing the search query

Attributes

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

Value members

Concrete methods

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

Creates a new ContentClient instance.

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