Packages

object ConsumerFilter extends ExtensionId[ConsumerFilter]

Extension to dynamically control the filters for the GrpcReadJournal.

Annotations
@ApiMayChange()
Source
ConsumerFilter.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerFilter
  2. ExtensionId
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Command extends AnyRef
  2. final case class CurrentFilter(streamId: String, criteria: Seq[FilterCriteria]) extends Product with Serializable
  3. final case class EntityIdOffset(entityId: String, seqNr: Long) extends Product with Serializable
  4. 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.

  5. 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.

  6. 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.

  7. sealed trait FilterCriteria extends AnyRef
  8. final case class GetFilter(streamId: String, replyTo: ActorRef[CurrentFilter]) extends Command with Product with Serializable
  9. 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). If seqNr is 0 events will not be replayed.

  10. 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.

  11. 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.

  12. 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.

  13. final case class PersistenceIdOffset(persistenceIdId: String, seqNr: Long) extends Product with Serializable
  14. sealed trait RemoveCriteria extends FilterCriteria
  15. final case class RemoveExcludeEntityIds(entityIds: Set[String]) extends RemoveCriteria with Product with Serializable

    Remove a previously added ExcludeEntityIds.

  16. final case class RemoveExcludeRegexEntityIds(matching: Set[String]) extends RemoveCriteria with Product with Serializable

    Remove a previously added ExcludeRegexEntityIds.

  17. final case class RemoveExcludeTags(tags: Set[String]) extends RemoveCriteria with Product with Serializable

    Remove a previously added ExcludeTags.

  18. final case class RemoveIncludeEntityIds(entityIds: Set[String]) extends RemoveCriteria with Product with Serializable

    Remove a previously added IncludeEntityIds.

  19. final case class RemoveIncludeRegexEntityIds(matching: Set[String]) extends RemoveCriteria with Product with Serializable

    Remove a previously added IncludeRegexEntityIds.

  20. final case class RemoveIncludeTags(tags: Set[String]) extends FilterCriteria with Product with Serializable

    Remove a previously added IncludeTags.

  21. final case class RemoveIncludeTopics(expressions: Set[String]) extends FilterCriteria with Product with Serializable

    Remove a previously added IncludeTopics.

  22. final case class Replay(streamId: String, persistenceIdOffsets: Set[PersistenceIdOffset]) extends SubscriberCommand with Product with Serializable

    Explicit request to replay events for given entities.

  23. final case class ReplayPersistenceId(persistenceIdOffset: PersistenceIdOffset, filterAfterSeqNr: Long) extends Product with Serializable
  24. final case class ReplayWithFilter(streamId: String, replayPersistenceIds: Set[ReplayPersistenceId]) extends SubscriberCommand with Product with Serializable

    Explicit request to replay events for given entities.

  25. sealed trait SubscriberCommand extends Command
  26. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def apply(system: ActorSystem[_]): ConsumerFilter
    Definition Classes
    ExtensionId
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. def createExtension(system: ActorSystem[_]): ConsumerFilter
    Definition Classes
    ConsumerFilter → ExtensionId
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def equals(other: Any): Boolean
    Definition Classes
    ExtensionId → AnyRef → Any
  10. 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.

  11. def get(system: ActorSystem[_]): ConsumerFilter

    Java API: retrieve the extension instance for the given system.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def hashCode(): Int
    Definition Classes
    ExtensionId → AnyRef → Any
  14. def id: ExtensionId[ConsumerFilter]
    Definition Classes
    ExtensionId
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. object ExcludeEntityIds extends Serializable
  25. object IncludeEntityIds extends Serializable
  26. object RemoveExcludeEntityIds extends Serializable
  27. object RemoveIncludeEntityIds extends Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from ExtensionId[ConsumerFilter]

Inherited from AnyRef

Inherited from Any

Ungrouped