Packages

final class EntityContext[M] extends AnyRef

Parameter to createBehavior function in Entity.apply.

Cluster Sharding is often used together with akka.persistence.typed.scaladsl.EventSourcedBehavior for the entities. See more considerations in akka.persistence.typed.PersistenceId. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

PersistenceId(entityContext.entityTypeKey.name, entityContext.entityId)
Source
ClusterSharding.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityContext
  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

Instance Constructors

  1. new EntityContext(entityTypeKey: EntityTypeKey[M], entityId: String, shard: ActorRef[ShardCommand])

    entityTypeKey

    the key of the entity type

    entityId

    the business domain identifier of the entity

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 EntityContext[M] toany2stringadd[EntityContext[M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EntityContext[M], B)
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toArrowAssoc[EntityContext[M]] 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() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (EntityContext[M]) => Boolean, msg: => Any): EntityContext[M]
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toEnsuring[EntityContext[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EntityContext[M]) => Boolean): EntityContext[M]
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toEnsuring[EntityContext[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): EntityContext[M]
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toEnsuring[EntityContext[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EntityContext[M]
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toEnsuring[EntityContext[M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. val entityId: String
  13. val entityTypeKey: EntityTypeKey[M]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val shard: ActorRef[ShardCommand]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toStringFormat[EntityContext[M]] 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): (EntityContext[M], B)
    Implicit
    This member is added by an implicit conversion from EntityContext[M] toArrowAssoc[EntityContext[M]] 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 fromEntityContext[M] to any2stringadd[EntityContext[M]]

Inherited by implicit conversion StringFormat fromEntityContext[M] to StringFormat[EntityContext[M]]

Inherited by implicit conversion Ensuring fromEntityContext[M] to Ensuring[EntityContext[M]]

Inherited by implicit conversion ArrowAssoc fromEntityContext[M] to ArrowAssoc[EntityContext[M]]

Ungrouped