sec.api

package sec.api

Type members

Classlikes

final case
class Checkpoint(logPosition: Exact)

Checkpoint result used with server-side filtering in EventStoreDB. Contains the LogPosition.Exact when the checkpoint was made.

Checkpoint result used with server-side filtering in EventStoreDB. Contains the LogPosition.Exact when the checkpoint was made.

final case
class ClusterInfo(members: Set[MemberInfo])

Used for information about the nodes in an EventStoreDB cluster.

Used for information about the nodes in an EventStoreDB cluster.

Companion
object
Companion
class
final case
class DeleteResult(logPosition: Exact)

The LogPosition.Exact of the delete in the transaction log.

The LogPosition.Exact of the delete in the transaction log.

sealed
trait Direction

Direction used when reading from a stream with variants:

Direction used when reading from a stream with variants:

Companion
object
object Direction
Companion
class
final case
class Endpoint(address: String, port: Int)

Endpoint can be an IP Socket Address consisting of an IP address and port number. It can also be a hostname and a port number, in which case an attempt will be made to resolve the hostname.

Endpoint can be an IP Socket Address consisting of an IP address and port number. It can also be a hostname and a port number, in which case an attempt will be made to resolve the hostname.

Companion
object
object Endpoint
Companion
class
final case
class EventFilter(kind: Kind, option: Either[NonEmptyList[PrefixFilter], RegexFilter])

Used for server-side event stream filtering. There are two kinds of filters:

Used for server-side event stream filtering. There are two kinds of filters:

In combination with EventFilter.Kind you can choose between two types of filter expressions:

  • EventFilter.PrefixFilter when you wish to filter for prefixes. An example of this is PrefixFilter("user_stream") for streams starting with the string value "user_stream" like "user_stream-a" and "user_stream-b".

  • EventFilter.RegexFilter when you wish to filter with a regular expression. An example of this is RegexFilter("^[^$].*") when you for do not wish to retrieve events starting with $.

Companion
object
Companion
class
final case
class MemberInfo(instanceId: UUID, timestamp: ZonedDateTime, state: VNodeState, isAlive: Boolean, httpEndpoint: Endpoint)
Companion
object
object MemberInfo
Companion
class
sealed

Used in conjunction with cluster connections where you provide a preference about what state a node should be in.

Used in conjunction with cluster connections where you provide a preference about what state a node should be in.

There are three variants:

Companion
object
Companion
class
sealed abstract case
class SubscriptionFilterOptions(filter: EventFilter, maxSearchWindow: Option[Int], checkpointIntervalMultiplier: Int)
Companion
object
final case
class TombstoneResult(logPosition: Exact)

The LogPosition.Exact of the tombstone in the transaction log.

The LogPosition.Exact of the tombstone in the transaction log.

sealed abstract case
class UserCredentials(username: String, password: String)

Credentials used for EventStoreDB connections.

Credentials used for EventStoreDB connections.

Companion
object
Companion
class
sealed
Companion
object
object VNodeState
Companion
class
final case
class WriteResult(streamPosition: Exact, logPosition: Exact)

The current last StreamPosition.Exact of the stream appended to and its corresponding LogPosition.Exact in the transaction log.

The current last StreamPosition.Exact of the stream appended to and its corresponding LogPosition.Exact in the transaction log.

object exceptions