Class/Object

eventstore

ProjectionsClient

Related Docs: object ProjectionsClient | package eventstore

Permalink

class ProjectionsClient extends ProjectionsUrls

A client allowing to create, get the status and delete an existing projection.

Linear Supertypes
ProjectionsUrls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProjectionsClient
  2. ProjectionsUrls
  3. AnyRef
  4. 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 ProjectionsClient(settings: Settings = Settings.Default, system: ActorSystem)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to any2stringadd[ProjectionsClient] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ProjectionsClient, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to ArrowAssoc[ProjectionsClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createProjection(name: String, javascript: String, mode: ProjectionMode = Continuous, allowEmit: Boolean = true): Future[ProjectionCreationResult]

    Permalink

    Create the projection with the specified name and code

    Create the projection with the specified name and code

    name

    the name of the projection to create

    javascript

    the javascript code for the projection

    mode

    the projection's mode (Either OneTime, Continuous or Transient)

    allowEmit

    indicates if the projection is allowed to emit new events.

  9. def createProjectionUrl(name: String, mode: ProjectionMode = Continuous, allowEmit: Boolean = true): String

    Permalink
    Attributes
    protected
    Definition Classes
    ProjectionsUrls
  10. def deleteProjection(name: String): Future[ProjectionDeleteResult]

    Permalink

    Try to delete the projection with the specified name.

    Try to delete the projection with the specified name. To delete a projection. It must be stopped first (see #stopProjection)

    name

    the name of the projection to stop

    returns

    a future telling whether the action was done (@ProjectionDeleted) or if it was not able to do so (@UnableToDeleteProjection)

  11. def ensuring(cond: (ProjectionsClient) ⇒ Boolean, msg: ⇒ Any): ProjectionsClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to Ensuring[ProjectionsClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ProjectionsClient) ⇒ Boolean): ProjectionsClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to Ensuring[ProjectionsClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): ProjectionsClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to Ensuring[ProjectionsClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ProjectionsClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to Ensuring[ProjectionsClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def fetchProjectionDetails(name: String): Future[Option[ProjectionDetails]]

    Permalink

    Fetch the details for the specified projection.

    Fetch the details for the specified projection.

    name

    the name of the projection

    returns

    the Projection details if it exist. None otherwise

  18. def fetchProjectionResult(name: String, partition: Option[String] = None): Future[Option[String]]

    Permalink

    Fetch the projection's result.

    Fetch the projection's result. It only works for OneTime projections as Continuous one dont provide a result.

    name

    the name of the projection

    partition

    the name of the partition

    returns

    a String that should be either empty or a valid json object with the projection's result.

  19. def fetchProjectionResultUrl(name: String, partition: Option[String]): String

    Permalink
    Attributes
    protected
    Definition Classes
    ProjectionsUrls
  20. def fetchProjectionState(name: String, partition: Option[String] = None): Future[Option[String]]

    Permalink

    Fetch the projection's state

    Fetch the projection's state

    name

    the name of the projection

    partition

    the name of the partition

    returns

    a String that should be either empty or a valid json object with the current state.

  21. def fetchProjectionStateUrl(name: String, partition: Option[String]): String

    Permalink
    Attributes
    protected
    Definition Classes
    ProjectionsUrls
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to StringFormat[ProjectionsClient] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. implicit val materializer: ActorMaterializer

    Permalink
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def projectionBaseUrl(name: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    ProjectionsUrls
  32. def projectionCommandUrl(name: String, command: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    ProjectionsUrls
  33. def startProjection(name: String): Future[Unit]

    Permalink

    Start the projection with the specified name.

    Start the projection with the specified name. Note that when eventstore responds to the command. It only acknowledges it. To know when it is started, you should use #waitForProjectionStatus

    name

    the name of the projection to start

    returns

    a future completed when the request is completed.

  34. def stopProjection(name: String): Future[Unit]

    Permalink

    Stop the projection with the specified name.

    Stop the projection with the specified name. Note that when eventstore responds to the command. It only acknowledges it. To know when it is stopped, you should use #waitForProjectionStatus

    name

    the name of the projection to stop

    returns

    a future completed when the request is completed.

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def [B](y: B): (ProjectionsClient, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ProjectionsClient to ArrowAssoc[ProjectionsClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ProjectionsUrls

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped