Packages

final case class EventSource(consumerGroup: String = "", source: Source = kalix.eventing.EventSource.Source.Empty, ignore: Boolean = false, ignoreUnknown: Option[Boolean] = _root_.scala.None, handleDeletes: Option[Boolean] = _root_.scala.None, startFromSnapshots: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EventSource] with Product with Serializable

Event source configuration

consumerGroup

The consumer group id. By default, all rpc methods on a given service with the same source will be part of the same virtual consumer group, messages will be routed to the different methods by type. This can be used to override that. If you want multiple methods to act as independent consumers of the same source (ie, if you want the same event to be published to each consumer) then give each consumer a unique name. Note that this does depend on the event source supporting multiple consumer groups. Queue based event sources may not support this.

ignore

If the message is not of interest for consumption the method for that input message type can be marked with ignore: true. Enabling is more efficient than implementing the method. This option can only be used on method level

ignoreUnknown

If an incoming event does not have a matching handler, ignore the event and continue processing subsequent events, default is to fail to not accidentally miss events of newly added or unknown event types, as once eventing has continued there is no way to later revisit the ignored event. Enabling is more efficient than implementing a catch-all method. This option can only be used on service level.

handleDeletes

Call this method when an entity has been deleted, the method must accept google.protobuf.Empty as input. If the method is in a view the return type should be the view state message type, for other types of components the returned message type can be an arbitrary message, for example for publishing to eventing out on delete. Currently supported only for the value entity streams.

startFromSnapshots

Start consuming from snapshots for event sourced entity sources. When enabled, the consumer will start by processing the latest snapshot state for each entity before processing subsequent events. This can significantly reduce startup time for consumers that need to rebuild state from a long event history. Only applicable for event_sourced_entity sources.

Annotations
@SerialVersionUID()
Source
EventSource.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventSource
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EventSource(consumerGroup: String = "", source: Source = kalix.eventing.EventSource.Source.Empty, ignore: Boolean = false, ignoreUnknown: Option[Boolean] = _root_.scala.None, handleDeletes: Option[Boolean] = _root_.scala.None, startFromSnapshots: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    consumerGroup

    The consumer group id. By default, all rpc methods on a given service with the same source will be part of the same virtual consumer group, messages will be routed to the different methods by type. This can be used to override that. If you want multiple methods to act as independent consumers of the same source (ie, if you want the same event to be published to each consumer) then give each consumer a unique name. Note that this does depend on the event source supporting multiple consumer groups. Queue based event sources may not support this.

    ignore

    If the message is not of interest for consumption the method for that input message type can be marked with ignore: true. Enabling is more efficient than implementing the method. This option can only be used on method level

    ignoreUnknown

    If an incoming event does not have a matching handler, ignore the event and continue processing subsequent events, default is to fail to not accidentally miss events of newly added or unknown event types, as once eventing has continued there is no way to later revisit the ignored event. Enabling is more efficient than implementing a catch-all method. This option can only be used on service level.

    handleDeletes

    Call this method when an entity has been deleted, the method must accept google.protobuf.Empty as input. If the method is in a view the return type should be the view state message type, for other types of components the returned message type can be an arbitrary message, for example for publishing to eventing out on delete. Currently supported only for the value entity streams.

    startFromSnapshots

    Start consuming from snapshots for event sourced entity sources. When enabled, the consumer will start by processing the latest snapshot state for each entity before processing subsequent events. This can significantly reduce startup time for consumers that need to rebuild state from a long event history. Only applicable for event_sourced_entity sources.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EventSource toany2stringadd[EventSource] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventSource, B)
    Implicit
    This member is added by an implicit conversion from EventSource toArrowAssoc[EventSource] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearHandleDeletes: EventSource
  8. def clearIgnoreUnknown: EventSource
  9. def clearSource: EventSource
  10. def clearStartFromSnapshots: EventSource
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def companion: EventSource.type
    Definition Classes
    EventSource → GeneratedMessage
  13. val consumerGroup: String
  14. def discardUnknownFields: EventSource
  15. def ensuring(cond: (EventSource) => Boolean, msg: => Any): EventSource
    Implicit
    This member is added by an implicit conversion from EventSource toEnsuring[EventSource] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (EventSource) => Boolean): EventSource
    Implicit
    This member is added by an implicit conversion from EventSource toEnsuring[EventSource] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): EventSource
    Implicit
    This member is added by an implicit conversion from EventSource toEnsuring[EventSource] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): EventSource
    Implicit
    This member is added by an implicit conversion from EventSource toEnsuring[EventSource] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getDirect: DirectSource
  22. def getEventSourcedEntity: String
  23. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    EventSource → GeneratedMessage
  24. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    EventSource → GeneratedMessage
  25. def getHandleDeletes: Boolean
  26. def getIgnoreUnknown: Boolean
  27. def getStartFromSnapshots: Boolean
  28. def getTopic: String
  29. def getValueEntity: String
  30. val handleDeletes: Option[Boolean]
  31. val ignore: Boolean
  32. val ignoreUnknown: Option[Boolean]
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. def serializedSize: Int
    Definition Classes
    EventSource → GeneratedMessage
  39. val source: Source
  40. val startFromSnapshots: Option[Boolean]
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  43. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  44. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  45. def toProtoString: String
    Definition Classes
    EventSource → GeneratedMessage
  46. val unknownFields: UnknownFieldSet
  47. def update(ms: (Lens[EventSource, EventSource]) => Mutation[EventSource]*): EventSource
    Definition Classes
    Updatable
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. def withConsumerGroup(__v: String): EventSource
  52. def withDirect(__v: DirectSource): EventSource
  53. def withEventSourcedEntity(__v: String): EventSource
  54. def withHandleDeletes(__v: Boolean): EventSource
  55. def withIgnore(__v: Boolean): EventSource
  56. def withIgnoreUnknown(__v: Boolean): EventSource
  57. def withSource(__v: Source): EventSource
  58. def withStartFromSnapshots(__v: Boolean): EventSource
  59. def withTopic(__v: String): EventSource
  60. def withUnknownFields(__v: UnknownFieldSet): EventSource
  61. def withValueEntity(__v: String): EventSource
  62. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  63. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    EventSource → GeneratedMessage
  64. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EventSource toStringFormat[EventSource] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (EventSource, B)
    Implicit
    This member is added by an implicit conversion from EventSource toArrowAssoc[EventSource] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Updatable[EventSource]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEventSource to any2stringadd[EventSource]

Inherited by implicit conversion StringFormat fromEventSource to StringFormat[EventSource]

Inherited by implicit conversion Ensuring fromEventSource to Ensuring[EventSource]

Inherited by implicit conversion ArrowAssoc fromEventSource to ArrowAssoc[EventSource]

Ungrouped