Packages

t

kalix.scalasdk

EntityOptions

trait EntityOptions extends ComponentOptions

Options used for configuring an entity.

Source
EntityOptions.scala
Linear Supertypes
ComponentOptions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityOptions
  2. ComponentOptions
  3. AnyRef
  4. 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 forwardHeaders: Set[String]

    returns

    the headers requested to be forwarded as metadata (cannot be mutated, use withForwardHeaders)

    Definition Classes
    EntityOptions → ComponentOptions
  2. abstract def passivationStrategy: PassivationStrategy

    returns

    the passivation strategy for an entity

  3. abstract def withForwardHeaders(headers: Set[String]): EntityOptions

    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
    EntityOptions → ComponentOptions
  4. abstract def withPassivationStrategy(strategy: PassivationStrategy): EntityOptions

    Create an entity option with the given passivation strategy.

    Create an entity option with the given passivation strategy.

    strategy

    to be used

    returns

    the entity option

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEntityOptions to any2stringadd[EntityOptions]

Inherited by implicit conversion StringFormat fromEntityOptions to StringFormat[EntityOptions]

Inherited by implicit conversion Ensuring fromEntityOptions to Ensuring[EntityOptions]

Inherited by implicit conversion ArrowAssoc fromEntityOptions to ArrowAssoc[EntityOptions]

Ungrouped