Packages

  • package root
    Definition Classes
    root
  • package kalix
    Definition Classes
    root
  • package scalasdk
    Definition Classes
    kalix
  • package view
    Definition Classes
    scalasdk
  • object View
    Definition Classes
    view
  • object UpdateEffect

    An UpdateEffect is a description of what Kalix needs to do after the command is handled.

    An UpdateEffect is a description of what Kalix needs to do after the command is handled. You can think of it as a set of instructions you are passing to Kalix. Kalix will process the instructions on your behalf and ensure that any data that needs to be persisted will be persisted.

    Each Kalix component defines its own effects, which are a set of predefined operations that match the capabilities of that component.

    A View UpdateEffect can either:

    • update the view state
    • delete the view state
    • ignore the event or state change notification (and not update the view state)

    Construct the effect that is returned by the command handler. The effect describes next processing actions, such as emitting events and sending a reply.

    Definition Classes
    View
  • Builder

sealed trait Builder[S] extends AnyRef

Source
View.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def deleteState(): UpdateEffect[S]
  2. abstract def error(description: String): UpdateEffect[S]

    Trigger an error for the event.

    Trigger an error for the event. Returning this effect is equivalent to throwing an exception from the handler and will lead to retrying processing of the same event until it is handled successfully.

    description

    The description of the error.

  3. abstract def ignore(): UpdateEffect[S]

    Ignore this event (and continue to process the next).

  4. abstract def updateState(newState: S): UpdateEffect[S]

Concrete 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 Builder[S] toany2stringadd[Builder[S]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Builder[S], B)
    Implicit
    This member is added by an implicit conversion from Builder[S] toArrowAssoc[Builder[S]] 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (Builder[S]) => Boolean, msg: => Any): Builder[S]
    Implicit
    This member is added by an implicit conversion from Builder[S] toEnsuring[Builder[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Builder[S]) => Boolean): Builder[S]
    Implicit
    This member is added by an implicit conversion from Builder[S] toEnsuring[Builder[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Builder[S]
    Implicit
    This member is added by an implicit conversion from Builder[S] toEnsuring[Builder[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Builder[S]
    Implicit
    This member is added by an implicit conversion from Builder[S] toEnsuring[Builder[S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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 Builder[S] toStringFormat[Builder[S]] 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): (Builder[S], B)
    Implicit
    This member is added by an implicit conversion from Builder[S] toArrowAssoc[Builder[S]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBuilder[S] to any2stringadd[Builder[S]]

Inherited by implicit conversion StringFormat fromBuilder[S] to StringFormat[Builder[S]]

Inherited by implicit conversion Ensuring fromBuilder[S] to Ensuring[Builder[S]]

Inherited by implicit conversion ArrowAssoc fromBuilder[S] to ArrowAssoc[Builder[S]]

Ungrouped