object ConsumerFilter extends ExtensionId[ConsumerFilter]
Extension to dynamically control the filters for the GrpcReadJournal
.
- Source
- ConsumerFilter.scala
- Alphabetic
- By Inheritance
- ConsumerFilter
- ExtensionId
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait Command extends AnyRef
- final case class CurrentFilter(streamId: String, criteria: Seq[FilterCriteria]) extends Product with Serializable
- final case class EntityIdOffset(entityId: String, seqNr: Long) extends Product with Serializable
- final case class ExcludeEntityIds(entityIds: Set[String]) extends FilterCriteria with Product with Serializable
Exclude events for entities with the given entity ids, unless there is a matching include filter that overrides the exclude.
- final case class ExcludeRegexEntityIds(matching: Set[String]) extends FilterCriteria with Product with Serializable
Exclude events for entities with entity ids matching the given regular expressions, unless there is a matching include filter that overrides the exclude.
- final case class ExcludeTags(tags: Set[String]) extends FilterCriteria with Product with Serializable
Exclude events with any of the given tags, unless there is a matching include filter that overrides the exclude.
- sealed trait FilterCriteria extends AnyRef
- final case class GetFilter(streamId: String, replyTo: ActorRef[CurrentFilter]) extends Command with Product with Serializable
- final case class IncludeEntityIds(entityOffsets: Set[EntityIdOffset]) extends FilterCriteria with Product with Serializable
Include events for entities with the given entity ids.
Include events for entities with the given entity ids. A matching include overrides a matching exclude.
For the given entity ids a
seqNr
can be defined to replay all events for the entity from the sequence number (inclusive). IfseqNr
is 0 events will not be replayed. - final case class IncludeRegexEntityIds(matching: Set[String]) extends FilterCriteria with Product with Serializable
Include events for entities with entity ids matching the given regular expressions.
Include events for entities with entity ids matching the given regular expressions. A matching include overrides a matching exclude.
- final case class IncludeTags(tags: Set[String]) extends FilterCriteria with Product with Serializable
Include events with any of the given tags.
Include events with any of the given tags. A matching include overrides a matching exclude.
- final case class IncludeTopics(expressions: Set[String]) extends FilterCriteria with Product with Serializable
Include events with any of the given matching topics.
Include events with any of the given matching topics. A matching include overrides a matching exclude.
Topic match expression according to MQTT specification, including wildcards. The topic of an event is defined by a tag with certain prefix, see
topic-tag-prefix
configuration. - final case class PersistenceIdOffset(persistenceIdId: String, seqNr: Long) extends Product with Serializable
- sealed trait RemoveCriteria extends FilterCriteria
- final case class RemoveExcludeEntityIds(entityIds: Set[String]) extends RemoveCriteria with Product with Serializable
Remove a previously added ExcludeEntityIds.
- final case class RemoveExcludeRegexEntityIds(matching: Set[String]) extends RemoveCriteria with Product with Serializable
Remove a previously added ExcludeRegexEntityIds.
- final case class RemoveExcludeTags(tags: Set[String]) extends RemoveCriteria with Product with Serializable
Remove a previously added ExcludeTags.
- final case class RemoveIncludeEntityIds(entityIds: Set[String]) extends RemoveCriteria with Product with Serializable
Remove a previously added IncludeEntityIds.
- final case class RemoveIncludeRegexEntityIds(matching: Set[String]) extends RemoveCriteria with Product with Serializable
Remove a previously added IncludeRegexEntityIds.
- final case class RemoveIncludeTags(tags: Set[String]) extends FilterCriteria with Product with Serializable
Remove a previously added IncludeTags.
- final case class RemoveIncludeTopics(expressions: Set[String]) extends FilterCriteria with Product with Serializable
Remove a previously added IncludeTopics.
- final class Replay extends Product2[String, Set[PersistenceIdOffset]] with SubscriberCommand with Serializable
Explicit request to replay events for given entities.
Explicit request to replay events for given entities.
Use the
replayCorrelationId
from theGrpcReadJournal
. - final case class ReplayPersistenceId(persistenceIdOffset: PersistenceIdOffset, filterAfterSeqNr: Long) extends Product with Serializable
- final class ReplayWithFilter extends Product2[String, Set[ReplayPersistenceId]] with SubscriberCommand with Serializable
Explicit request to replay events for given entities.
Explicit request to replay events for given entities.
Use the
replayCorrelationId
from theGrpcReadJournal
. - sealed trait SubscriberCommand extends Command
- final case class UpdateFilter(streamId: String, criteria: Seq[FilterCriteria]) extends SubscriberCommand with Product with Serializable
Add or remove filter criteria.
Add or remove filter criteria.
Exclude criteria are evaluated first. If no matching exclude criteria the event is emitted. If an exclude criteria is matching the include criteria are evaluated. If no matching include criteria the event is discarded. If matching include criteria the event is emitted.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def apply(system: ActorSystem[_]): ConsumerFilter
- Definition Classes
- ExtensionId
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def createExtension(system: ActorSystem[_]): ConsumerFilter
- Definition Classes
- ConsumerFilter → ExtensionId
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def equals(other: Any): Boolean
- Definition Classes
- ExtensionId → AnyRef → Any
- val excludeAll: FilterCriteria
Exclude events from all entity ids, convenience for combining with for example a topic filter to include only events matching the topic filter.
- def get(system: ActorSystem[_]): ConsumerFilter
Java API: retrieve the extension instance for the given system.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def hashCode(): Int
- Definition Classes
- ExtensionId → AnyRef → Any
- def id: ExtensionId[ConsumerFilter]
- Definition Classes
- ExtensionId
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object ExcludeEntityIds extends Serializable
- object IncludeEntityIds extends Serializable
- object RemoveExcludeEntityIds extends Serializable
- object RemoveIncludeEntityIds extends Serializable
- object Replay extends AbstractFunction2[String, Set[PersistenceIdOffset], Replay] with Serializable
- object ReplayWithFilter extends AbstractFunction2[String, Set[ReplayPersistenceId], ReplayWithFilter] with Serializable