trait 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 or a broker topic. In Lagom the term 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/java/Projections.html
- Annotations
- @ApiMayChange()
- Source
- Projections.java
- Alphabetic
- By Inheritance
- Projections
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def getStatus(): CompletionStage[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
Stateso multiple invocations in different nodes of the cluster may return different versions ofStatewhen it is evolving (e.g. during a rolling upgrade, while attending a user request to stop/start,...)- returns
an eventually consistent list of projections' metadata
- abstract 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 methodgetStatus. - abstract def startWorker(projectionName: String, tagName: String): Unit
Given a
projectionNameand atagNamerequest a single worker to start.Given a
projectionNameand atagNamerequest 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 methodgetStatus. - abstract 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 methodgetStatus. - abstract def stopWorker(projectionName: String, tagName: String): Unit
Given a
projectionNameand atagNamerequest a single worker to stop.Given a
projectionNameand atagNamerequest 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 methodgetStatus.
Concrete 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 Projections toany2stringadd[Projections] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (Projections, B)
- Implicit
- This member is added by an implicit conversion from Projections toArrowAssoc[Projections] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Projections) => Boolean, msg: => Any): Projections
- Implicit
- This member is added by an implicit conversion from Projections toEnsuring[Projections] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Projections) => Boolean): Projections
- Implicit
- This member is added by an implicit conversion from Projections toEnsuring[Projections] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Projections
- Implicit
- This member is added by an implicit conversion from Projections toEnsuring[Projections] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Projections
- Implicit
- This member is added by an implicit conversion from Projections toEnsuring[Projections] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Projections toStringFormat[Projections] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
Deprecated Value Members
- def →[B](y: B): (Projections, B)
- Implicit
- This member is added by an implicit conversion from Projections toArrowAssoc[Projections] 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.