final case class EntitySettings(entityType: String = "", passivationStrategy: Option[PassivationStrategy] = _root_.scala.None, forwardHeaders: Seq[String] = _root_.scala.Seq.empty, specificSettings: SpecificSettings = kalix.protocol.discovery.EntitySettings.SpecificSettings.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EntitySettings] with Product with Serializable

shared settings for entities (event sourced/value/replicated entity)

entityType

namespace for persisted or replicated state

passivationStrategy

Note: passivation strategy settings for value entities and event sourced entities are ignored. Passivation timeout can only be configured for replicated entities. Passivation strategy settings may be completely removed in future versions of the protocol.

forwardHeaders

header names to ask the proxy to forward from the request as metadata to the component calls note that the proxy may filter out Kalix internal headers from this list to not leak implementation details

Annotations
@SerialVersionUID()
Source
EntitySettings.scala
Linear Supertypes
Updatable[EntitySettings], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntitySettings
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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 EntitySettings(entityType: String = "", passivationStrategy: Option[PassivationStrategy] = _root_.scala.None, forwardHeaders: Seq[String] = _root_.scala.Seq.empty, specificSettings: SpecificSettings = kalix.protocol.discovery.EntitySettings.SpecificSettings.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    entityType

    namespace for persisted or replicated state

    passivationStrategy

    Note: passivation strategy settings for value entities and event sourced entities are ignored. Passivation timeout can only be configured for replicated entities. Passivation strategy settings may be completely removed in future versions of the protocol.

    forwardHeaders

    header names to ask the proxy to forward from the request as metadata to the component calls note that the proxy may filter out Kalix internal headers from this list to not leak implementation details

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 EntitySettings toany2stringadd[EntitySettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EntitySettings, B)
    Implicit
    This member is added by an implicit conversion from EntitySettings toArrowAssoc[EntitySettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAllForwardHeaders(__vs: Iterable[String]): EntitySettings
  7. def addForwardHeaders(__vs: String*): EntitySettings
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearForwardHeaders: EntitySettings
  10. def clearPassivationStrategy: EntitySettings
  11. def clearSpecificSettings: EntitySettings
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def companion: EntitySettings.type
    Definition Classes
    EntitySettings → GeneratedMessage
  14. def discardUnknownFields: EntitySettings
  15. def ensuring(cond: (EntitySettings) => Boolean, msg: => Any): EntitySettings
    Implicit
    This member is added by an implicit conversion from EntitySettings toEnsuring[EntitySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (EntitySettings) => Boolean): EntitySettings
    Implicit
    This member is added by an implicit conversion from EntitySettings toEnsuring[EntitySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): EntitySettings
    Implicit
    This member is added by an implicit conversion from EntitySettings toEnsuring[EntitySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): EntitySettings
    Implicit
    This member is added by an implicit conversion from EntitySettings toEnsuring[EntitySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. val entityType: String
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. val forwardHeaders: Seq[String]
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    EntitySettings → GeneratedMessage
  24. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    EntitySettings → GeneratedMessage
  25. def getPassivationStrategy: PassivationStrategy
  26. def getReplicatedEntity: ReplicatedEntitySettings
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. val passivationStrategy: Option[PassivationStrategy]
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. def serializedSize: Int
    Definition Classes
    EntitySettings → GeneratedMessage
  34. val specificSettings: SpecificSettings
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  37. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  38. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. def toProtoString: String
    Definition Classes
    EntitySettings → GeneratedMessage
  40. val unknownFields: UnknownFieldSet
  41. def update(ms: (Lens[EntitySettings, EntitySettings]) => Mutation[EntitySettings]*): EntitySettings
    Definition Classes
    Updatable
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. def withEntityType(__v: String): EntitySettings
  46. def withForwardHeaders(__v: Seq[String]): EntitySettings
  47. def withPassivationStrategy(__v: PassivationStrategy): EntitySettings
  48. def withReplicatedEntity(__v: ReplicatedEntitySettings): EntitySettings
  49. def withSpecificSettings(__v: SpecificSettings): EntitySettings
  50. def withUnknownFields(__v: UnknownFieldSet): EntitySettings
  51. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  52. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    EntitySettings → GeneratedMessage
  53. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

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

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEntitySettings to any2stringadd[EntitySettings]

Inherited by implicit conversion StringFormat fromEntitySettings to StringFormat[EntitySettings]

Inherited by implicit conversion Ensuring fromEntitySettings to Ensuring[EntitySettings]

Inherited by implicit conversion ArrowAssoc fromEntitySettings to ArrowAssoc[EntitySettings]

Ungrouped