Packages

abstract class View[S] extends AnyRef

Kalix applications follow the Command Query Responsibility Segregation (CQRS) pattern (see https://developer.lightbend.com/docs/akka-guide/concepts/cqrs.html).

Kalix' Entities represent the command side where you change the state of your model in a strictly consistent and isolated manner. Kalix' Views represent the query side of your application. Views are optimized for reads and allow you to query your model by fields other than the entity identifier.

When implementing a View, you define what will be its internal state (your view model) and how you want to query it. The Query string defines which fields will be indexed and how the query will be executed.

The query is executed by the Kalix when a request is made to the View.

Views are updated in response to Event Sourced Entity events, Value Entity state changes or messages from a Topic.

Each incoming change is handled by a command handler. Command handlers are methods returning an kalix.scalasdk.view.View.UpdateEffect. The command handler is responsible for updating the View state.

S

The type of the state for this view.

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

Instance Constructors

  1. new View()

Abstract Value Members

  1. abstract def emptyState: S

    returns

    an empty state object to hand to the process method when an event for a previously unknown subject id is seen.

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

    Additional context and metadata for an update handler.

    Additional context and metadata for an update handler.

    It will throw an exception if accessed from constructor.

    Attributes
    protected
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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 View[S] toStringFormat[View[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): (View[S], B)
    Implicit
    This member is added by an implicit conversion from View[S] toArrowAssoc[View[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 fromView[S] to any2stringadd[View[S]]

Inherited by implicit conversion StringFormat fromView[S] to StringFormat[View[S]]

Inherited by implicit conversion Ensuring fromView[S] to Ensuring[View[S]]

Inherited by implicit conversion ArrowAssoc fromView[S] to ArrowAssoc[View[S]]

Ungrouped