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
- Alphabetic
- By Inheritance
- Effect
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- abstract def addSideEffects(sideEffects: Seq[SideEffect]): Effect[T]
- abstract def canHaveSideEffects: Boolean
- returns
true if this effect supports attaching side effects, if returning false addSideEffects will throw an exception.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Effect[T], B)
- 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: (Effect[T]) => Boolean, msg: => Any): Effect[T]
- def ensuring(cond: (Effect[T]) => Boolean): Effect[T]
- def ensuring(cond: Boolean, msg: => Any): Effect[T]
- def ensuring(cond: Boolean): Effect[T]
- 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 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 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): (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.