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, 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.
- Annotations
- @SerialVersionUID()
- Source
- EventSource.scala
- Alphabetic
- By Inheritance
- EventSource
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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, 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearHandleDeletes: EventSource
- def clearIgnoreUnknown: EventSource
- def clearSource: EventSource
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: EventSource.type
- Definition Classes
- EventSource → GeneratedMessage
- val consumerGroup: String
- def discardUnknownFields: EventSource
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDirect: DirectSource
- def getEventSourcedEntity: String
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- EventSource → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- EventSource → GeneratedMessage
- def getHandleDeletes: Boolean
- def getIgnoreUnknown: Boolean
- def getTopic: String
- def getValueEntity: String
- val handleDeletes: Option[Boolean]
- val ignore: Boolean
- val ignoreUnknown: Option[Boolean]
- 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
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- EventSource → GeneratedMessage
- val source: Source
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- EventSource → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[EventSource, EventSource]) => Mutation[EventSource]*): EventSource
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- def withConsumerGroup(__v: String): EventSource
- def withDirect(__v: DirectSource): EventSource
- def withEventSourcedEntity(__v: String): EventSource
- def withHandleDeletes(__v: Boolean): EventSource
- def withIgnore(__v: Boolean): EventSource
- def withIgnoreUnknown(__v: Boolean): EventSource
- def withSource(__v: Source): EventSource
- def withTopic(__v: String): EventSource
- def withUnknownFields(__v: UnknownFieldSet): EventSource
- def withValueEntity(__v: String): EventSource
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- EventSource → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.