Packages

final class Projections extends AnyRef

Public interface to query the internal projection registry that keeps track of the 

State

of each projection. A projections is a process consuming an Akka Persistence Journal handling each event into a read table of a broker topic. In Lagom the erm projection only refers to ReadSideProcessor's and TopicProducers's (not Broker subscribers). This is different than the meaning of projection in akka/akka-projection.

See also https://www.lagomframework.com/documentation/latest/scala/Projections.html

State }}} A projections is a process consuming an Akka Persistence Journal handling each event into a read table of a broker topic. In Lagom the erm projection only refers to ReadSideProcessor's and TopicProducers's (not Broker subscribers). This is different than the meaning of projection in akka/akka-projection.

See also https://www.lagomframework.com/documentation/latest/scala/Projections.html

Annotations
@ApiMayChange()
Source
Projections.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Projections
  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. All

Instance Constructors

  1. new Projections(registry: ProjectionRegistry)

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 Projections to any2stringadd[Projections] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Projections, B)
    Implicit
    This member is added by an implicit conversion from Projections to ArrowAssoc[Projections] 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( ... ) @native()
  8. def ensuring(cond: (Projections) ⇒ Boolean, msg: ⇒ Any): Projections
    Implicit
    This member is added by an implicit conversion from Projections to Ensuring[Projections] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Projections) ⇒ Boolean): Projections
    Implicit
    This member is added by an implicit conversion from Projections to Ensuring[Projections] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Projections
    Implicit
    This member is added by an implicit conversion from Projections to Ensuring[Projections] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Projections
    Implicit
    This member is added by an implicit conversion from Projections to Ensuring[Projections] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Projections to StringFormat[Projections] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getStatus: Future[State]

    Read an eventually consistent copy of the projections and workers running on the service.

    Read an eventually consistent copy of the projections and workers running on the service. Invocations to this method return a local copy of the 

    State

    so multiple invocations in different nodes of the cluster may return different versions of 

    State

    when it is evolving (e.g. during a rolling upgrade, while attending a user request to stop/start,...) State }}} (e.g. during a rolling upgrade, while attending a user request to stop/start,...) State }}} different nodes of the cluster may return different versions of 

    State

    when it is evolving (e.g. during a rolling upgrade, while attending a user request to stop/start,...) State }}} (e.g. during a rolling upgrade, while attending a user request to stop/start,...)

    returns

    an eventually consistent list of projections' metadata

  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def startAllWorkers(projectionName: String): Unit

    Given a projectionName, request all its workers to start.

    Given a projectionName, request all its workers to start. This method returns immediately. Eventually, the request will propagate across the cluster and, after that, workers participating on that projection will start. To track the actual state of the workers, poll the projection registry using the method getStatus.

  24. def startWorker(projectionName: String, tagName: String): Unit

    Given a projectionName and a tagName request a single worker to start.

    Given a projectionName and a tagName request a single worker to start. This method returns immediately. Eventually, the request will propagate across the cluster and reach the node where that particular worker must be allocated allocated. Then, the worker will be started, it's status change will be observed and propagated back across the cluster. To track the actual state of the workers, poll the projection registry using the method getStatus.

  25. def stopAllWorkers(projectionName: String): Unit

    Given a projectionName, request all its workers to stop.

    Given a projectionName, request all its workers to stop. This method returns immediately. Eventually, the request will propagate across the cluster and, after that, workers participating on that projection will stop. To track the actual state of the workers, poll the projection registry using the method 

    Projections#getStatus

    .

    Projections#getStatus }}}

  26. def stopWorker(projectionName: String, tagName: String): Unit

    Given a projectionName and a tagName request a single worker to stop.

    Given a projectionName and a tagName request a single worker to stop. This method returns immediately. Eventually, the request will propagate across the cluster and reach the node where that particular worker is currently allocated. Then, the worker will be stopped, it's status change will be observed and propagated back across the cluster. To track the actual state of the workers, poll the projection registry using the method getStatus.

  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def →[B](y: B): (Projections, B)
    Implicit
    This member is added by an implicit conversion from Projections to ArrowAssoc[Projections] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Projections to any2stringadd[Projections]

Inherited by implicit conversion StringFormat from Projections to StringFormat[Projections]

Inherited by implicit conversion Ensuring from Projections to Ensuring[Projections]

Inherited by implicit conversion ArrowAssoc from Projections to ArrowAssoc[Projections]

Ungrouped