Packages

trait Effect[+T] extends AnyRef

An Effect 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.

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

An Action Effect can either:

  • reply with a message to the caller
  • reply with a message to be published to a topic (in case the method is a publisher)
  • forward the message to another component
  • return an error
  • ignore the call
T

The type of the message that must be returned by this call.

Source
Action.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effect
  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 addSideEffect(sideEffects: SideEffect*): Effect[T]

    Attach the given side effects to this reply.

    Attach the given side effects to this reply.

    sideEffects

    The effects to attach.

    returns

    A new reply with the attached effects.

  2. abstract def addSideEffects(sideEffects: Seq[SideEffect]): Effect[T]
  3. abstract def canHaveSideEffects: Boolean

    returns

    true if this effect supports attaching side effects, if returning false addSideEffects will throw an exception.

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 Effect[T] toany2stringadd[Effect[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Effect[T], B)
    Implicit
    This member is added by an implicit conversion from Effect[T] toArrowAssoc[Effect[T]] 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: (Effect[T]) => Boolean, msg: => Any): Effect[T]
    Implicit
    This member is added by an implicit conversion from Effect[T] toEnsuring[Effect[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Effect[T]) => Boolean): Effect[T]
    Implicit
    This member is added by an implicit conversion from Effect[T] toEnsuring[Effect[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Effect[T]
    Implicit
    This member is added by an implicit conversion from Effect[T] toEnsuring[Effect[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Effect[T]
    Implicit
    This member is added by an implicit conversion from Effect[T] toEnsuring[Effect[T]] 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 Effect[T] toStringFormat[Effect[T]] 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): (Effect[T], B)
    Implicit
    This member is added by an implicit conversion from Effect[T] toArrowAssoc[Effect[T]] 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 fromEffect[T] to any2stringadd[Effect[T]]

Inherited by implicit conversion StringFormat fromEffect[T] to StringFormat[Effect[T]]

Inherited by implicit conversion Ensuring fromEffect[T] to Ensuring[Effect[T]]

Inherited by implicit conversion ArrowAssoc fromEffect[T] to ArrowAssoc[Effect[T]]

Ungrouped