kalix.scalasdk.eventsourcedentity
EventSourcedEntityOptions
Companion object EventSourcedEntityOptions
trait EventSourcedEntityOptions extends EntityOptions
Root entity options for all event sourcing entities.
- Alphabetic
- By Inheritance
- EventSourcedEntityOptions
- EntityOptions
- ComponentOptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def forwardHeaders: Set[String]
- returns
the headers requested to be forwarded as metadata (cannot be mutated, use withForwardHeaders)
- Definition Classes
- EntityOptions → ComponentOptions
- abstract def snapshotEvery: Int
- abstract def withForwardHeaders(headers: Set[String]): EventSourcedEntityOptions
Ask Kalix to forward these headers from the incoming request as metadata headers for the incoming commands.
Ask Kalix to forward these headers from the incoming request as metadata headers for the incoming commands. By default no headers except "X-Server-Timing" are forwarded.
- Definition Classes
- EventSourcedEntityOptions → EntityOptions → ComponentOptions
- abstract def withSnapshotEvery(numberOfEvents: Int): EventSourcedEntityOptions
Specifies how snapshots of the entity state should be made: Zero means use default from configuration file.
Specifies how snapshots of the entity state should be made: Zero means use default from configuration file. Any negative value means never snapshot. Any positive value means snapshot at-or-after that number of events.
It is strongly recommended to not disable snapshotting unless it is known that event sourced entity will never have more than 100 events (in which case the default will anyway not trigger any snapshots)
Concrete 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 EventSourcedEntityOptions toany2stringadd[EventSourcedEntityOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EventSourcedEntityOptions, B)
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toArrowAssoc[EventSourcedEntityOptions] 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (EventSourcedEntityOptions) => Boolean, msg: => Any): EventSourcedEntityOptions
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toEnsuring[EventSourcedEntityOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EventSourcedEntityOptions) => Boolean): EventSourcedEntityOptions
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toEnsuring[EventSourcedEntityOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EventSourcedEntityOptions
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toEnsuring[EventSourcedEntityOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EventSourcedEntityOptions
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toEnsuring[EventSourcedEntityOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
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 EventSourcedEntityOptions toStringFormat[EventSourcedEntityOptions] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EventSourcedEntityOptions, B)
- Implicit
- This member is added by an implicit conversion from EventSourcedEntityOptions toArrowAssoc[EventSourcedEntityOptions] 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.