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
- Alphabetic
- By Inheritance
- EntitySettings
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllForwardHeaders(__vs: Iterable[String]): EntitySettings
- def addForwardHeaders(__vs: String*): EntitySettings
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearForwardHeaders: EntitySettings
- def clearPassivationStrategy: EntitySettings
- def clearSpecificSettings: EntitySettings
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: EntitySettings.type
- Definition Classes
- EntitySettings → GeneratedMessage
- def discardUnknownFields: EntitySettings
- 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
- 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
- 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
- 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
- val entityType: String
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val forwardHeaders: Seq[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- EntitySettings → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- EntitySettings → GeneratedMessage
- def getPassivationStrategy: PassivationStrategy
- def getReplicatedEntity: ReplicatedEntitySettings
- 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()
- val passivationStrategy: Option[PassivationStrategy]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- EntitySettings → GeneratedMessage
- val specificSettings: SpecificSettings
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- EntitySettings → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[EntitySettings, EntitySettings]) => Mutation[EntitySettings]*): EntitySettings
- Definition Classes
- Updatable
- 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()
- def withEntityType(__v: String): EntitySettings
- def withForwardHeaders(__v: Seq[String]): EntitySettings
- def withPassivationStrategy(__v: PassivationStrategy): EntitySettings
- def withReplicatedEntity(__v: ReplicatedEntitySettings): EntitySettings
- def withSpecificSettings(__v: SpecificSettings): EntitySettings
- def withUnknownFields(__v: UnknownFieldSet): EntitySettings
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- EntitySettings → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
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 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.