Packages

class Kalix extends AnyRef

The Kalix class is the main interface to configuring entities to deploy, and subsequently starting a local server which will expose these entities to the Kalix Runtime Sidecar.

Source
Kalix.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Kalix
  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

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 Kalix toany2stringadd[Kalix] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Kalix, B)
    Implicit
    This member is added by an implicit conversion from Kalix toArrowAssoc[Kalix] 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()
  8. def createRunner(config: Config): KalixRunner

    Creates a KalixRunner using the currently configured services, using the supplied configuration.

    Creates a KalixRunner using the currently configured services, using the supplied configuration. In order to start the server, run() must be invoked on the returned KalixRunner.

    returns

    a KalixRunner

  9. def createRunner(): KalixRunner

    Creates a KalixRunner using the currently configured services.

    Creates a KalixRunner using the currently configured services. In order to start the server, run() must be invoked on the returned KalixRunner.

    returns

    a KalixRunner

  10. def ensuring(cond: (Kalix) => Boolean, msg: => Any): Kalix
    Implicit
    This member is added by an implicit conversion from Kalix toEnsuring[Kalix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Kalix) => Boolean): Kalix
    Implicit
    This member is added by an implicit conversion from Kalix toEnsuring[Kalix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Kalix
    Implicit
    This member is added by an implicit conversion from Kalix toEnsuring[Kalix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Kalix
    Implicit
    This member is added by an implicit conversion from Kalix toEnsuring[Kalix] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  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()
  17. def getMessageCodec(): MessageCodec
  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 preferJavaProtobufs: Kalix

    When locating protobufs, if both a Java and a ScalaPB generated class is found on the classpath, this specifies that Java should be preferred.

    When locating protobufs, if both a Java and a ScalaPB generated class is found on the classpath, this specifies that Java should be preferred.

    returns

    This Kalix instance.

  24. def preferScalaProtobufs: Kalix

    When locating protobufs, if both a Java and a ScalaPB generated class is found on the classpath, this specifies that Scala should be preferred.

    When locating protobufs, if both a Java and a ScalaPB generated class is found on the classpath, this specifies that Scala should be preferred.

    returns

    This Kalix instance.

  25. def register[A <: Action](provider: ActionProvider[A]): Kalix

    Register an action using an kalix.scalasdk.action.ActionProvider.

    Register an action using an kalix.scalasdk.action.ActionProvider. The concrete ActionProvider is generated for the specific entities defined in Protobuf, for example CustomerActionProvider.

    returns

    This stateful service builder.

  26. def register(provider: ViewProvider): Kalix

    Register a view using a kalix.scalasdk.view.ViewProvider.

    Register a view using a kalix.scalasdk.view.ViewProvider. The concrete ViewProvider is generated for the specific views defined in Protobuf, for example CustomerViewProvider.

    returns

    This stateful service builder.

  27. def register[S, E <: EventSourcedEntity[S]](provider: EventSourcedEntityProvider[S, E]): Kalix

    Register a event sourced entity using a kalix.scalasdk.eventsourcedentity.EventSourcedEntityProvider.

    Register a event sourced entity using a kalix.scalasdk.eventsourcedentity.EventSourcedEntityProvider. The concrete EventSourcedEntityProvider is generated for the specific entities defined in Protobuf, for example CustomerEntityProvider.

    kalix.scalasdk.eventsourcedentity.EventSourcedEntityOptions can be defined by in the EventSourcedEntityProvider.

    returns

    This stateful service builder.

  28. def register[S >: Null, E <: AbstractWorkflow[S]](provider: WorkflowProvider[S, E]): Kalix

    Register a workflow using a kalix.scalasdk.workflow.WorkflowProvider.

    Register a workflow using a kalix.scalasdk.workflow.WorkflowProvider. The concrete WorkflowProvider is generated for the specific workflow defined in Protobuf, for example TransferWorkflowProvider.

    kalix.scalasdk.workflow.WorkflowOptions can be defined by in the WorkflowProvider.

    returns

    This stateful service builder.

  29. def register[S, E <: ValueEntity[S]](provider: ValueEntityProvider[S, E]): Kalix

    Register a value based entity using a kalix.scalasdk.valueentity.ValueEntityProvider.

    Register a value based entity using a kalix.scalasdk.valueentity.ValueEntityProvider. The concrete ValueEntityProvider is generated for the specific entities defined in Protobuf, for example CustomerEntityProvider.

    kalix.scalasdk.valueentity.ValueEntityOptions can be defined by in the ValueEntityProvider.

    returns

    This stateful service builder.

  30. def register[D <: ReplicatedData, E <: ReplicatedEntity[D]](provider: ReplicatedEntityProvider[D, E]): Kalix

    Register a replicated entity using a kalix.scalasdk.replicatedentity.ReplicatedEntityProvider.

    Register a replicated entity using a kalix.scalasdk.replicatedentity.ReplicatedEntityProvider. The concrete ReplicatedEntityProvider is generated for the specific entities defined in Protobuf, for example CustomerEntityProvider.

    kalix.scalasdk.replicatedentity.ReplicatedEntityOptions can be defined by in the ReplicatedEntityProvider .

    returns

    This stateful service builder.

  31. def start(config: Config): Future[Done]

    Starts a server with the configured entities, using the supplied configuration.

    Starts a server with the configured entities, using the supplied configuration.

    returns

    a CompletionStage which will be completed when the server has shut down.

  32. def start(): Future[Done]

    Starts a server with the configured entities.

    Starts a server with the configured entities.

    returns

    a CompletionStage which will be completed when the server has shut down.

  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. def withClassLoader(classLoader: ClassLoader): Kalix

    Sets the ClassLoader to be used for reflective access, the default value is the ClassLoader of the Kalix class.

    Sets the ClassLoader to be used for reflective access, the default value is the ClassLoader of the Kalix class.

    classLoader

    A non-null ClassLoader to be used for reflective access.

    returns

    This Kalix instance.

  39. def withTypeUrlPrefix(prefix: String): Kalix

    Sets the type URL prefix to be used when serializing and deserializing types from and to Protobyf Any values.

    Sets the type URL prefix to be used when serializing and deserializing types from and to Protobyf Any values. Defaults to "type.googleapis.com".

    prefix

    the type URL prefix to be used.

    returns

    This Kalix instance.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Kalix toStringFormat[Kalix] 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): (Kalix, B)
    Implicit
    This member is added by an implicit conversion from Kalix toArrowAssoc[Kalix] 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 fromKalix to any2stringadd[Kalix]

Inherited by implicit conversion StringFormat fromKalix to StringFormat[Kalix]

Inherited by implicit conversion Ensuring fromKalix to Ensuring[Kalix]

Inherited by implicit conversion ArrowAssoc fromKalix to ArrowAssoc[Kalix]

Ungrouped