Type Members

1.  final case class ClientAction(action: Action = ...) extends GeneratedMessage with Message[ClientAction] with Updatable[ClientAction] with Product with Serializable

   An action for the client

   An action for the client

   Annotations

   @SerialVersionUID()

2.  final case class Command(entityId: String = "", id: Long = 0L, name: String = "", payload: Option[Any] = _root_.scala.None, streamed: Boolean = false) extends GeneratedMessage with Message[Command] with Updatable[Command] with Product with Serializable

   A command.

   A command. For each command received, a reply must be sent with a matching command id.

   entityId

   The ID of the entity.

   id

   A command id.

   name

   Command name

   payload

   The command payload.

   streamed

   Whether the command is streamed or not

   Annotations

   @SerialVersionUID()

3.  final case class Entity(entityType: String = "", serviceName: String = "", persistenceId: String = "") extends GeneratedMessage with Message[Entity] with Updatable[Entity] with Product with Serializable
   entityType

   The type of entity. By convention, this should be a fully qualified entity protocol grpc service name, for example, cloudstate.eventsourced.EventSourced.

   serviceName

   The name of the service to load from the protobuf file.

   persistenceId

   The ID to namespace state by. How this is used depends on the type of entity, for example, event sourced entities will prefix this to the persistence id.

   Annotations

   @SerialVersionUID()

4.  trait EntityDiscovery extends AnyRef

   Entity discovery service.

5.  final case class EntitySpec(proto: ByteString = ..., entities: Seq[Entity] = _root_.scala.Seq.empty, serviceInfo: Option[ServiceInfo] = _root_.scala.None) extends GeneratedMessage with Message[EntitySpec] with Updatable[EntitySpec] with Product with Serializable
   proto

   This should be the Descriptors.FileDescriptorSet in proto serialized from as generated by: protoc --include_imports &92; --proto_path=<proto file directory> &92; --descriptor_set_out=user-function.desc &92; <path to .proto files>

   entities

   The entities being served.

   serviceInfo

   Optional information about the service.

   Annotations

   @SerialVersionUID()

6.  final case class Failure(commandId: Long = 0L, description: String = "") extends GeneratedMessage with Message[Failure] with Updatable[Failure] with Product with Serializable

   A failure reply.

   A failure reply. If this is returned, it will be translated into a gRPC unknown error with the corresponding description if supplied.

   commandId

   The id of the command being replied to. Must match the input command.

   description

   A description of the error.

   Annotations

   @SerialVersionUID()

7.  final case class Forward(serviceName: String = "", commandName: String = "", payload: Option[Any] = _root_.scala.None) extends GeneratedMessage with Message[Forward] with Updatable[Forward] with Product with Serializable

   Forwards handling of this request to another entity.

   Forwards handling of this request to another entity.

   serviceName

   The name of the service to forward to.

   commandName

   The name of the command.

   payload

   The payload.

   Annotations

   @SerialVersionUID()

8.  final case class ProxyInfo(protocolMajorVersion: Int = 0, protocolMinorVersion: Int = 0, proxyName: String = "", proxyVersion: String = "", supportedEntityTypes: Seq[String] = _root_.scala.Seq.empty) extends GeneratedMessage with Message[ProxyInfo] with Updatable[ProxyInfo] with Product with Serializable

   Annotations

   @SerialVersionUID()

9.  final case class Reply(payload: Option[Any] = _root_.scala.None) extends GeneratedMessage with Message[Reply] with Updatable[Reply] with Product with Serializable

   A reply to the sender.

   A reply to the sender.

   payload

   The reply payload

   Annotations

   @SerialVersionUID()

10.  final case class ServiceInfo(serviceName: String = "", serviceVersion: String = "", serviceRuntime: String = "", supportLibraryName: String = "", supportLibraryVersion: String = "") extends GeneratedMessage with Message[ServiceInfo] with Updatable[ServiceInfo] with Product with Serializable

    Information about the service that proxy is proxying to.

    Information about the service that proxy is proxying to. All of the information in here is optional. It may be useful for debug purposes.

    serviceName

    The name of the service, eg, "shopping-cart".

    serviceVersion

    The version of the service.

    serviceRuntime

    A description of the runtime for the service. Can be anything, but examples might be:

    • node v10.15.2
    • OpenJDK Runtime Environment 1.8.0_192-b12

    supportLibraryName

    If using a support library, the name of that library, eg "cloudstate"

    supportLibraryVersion

    The version of the support library being used.

    Annotations

    @SerialVersionUID()

11.  final case class SideEffect(serviceName: String = "", commandName: String = "", payload: Option[Any] = _root_.scala.None, synchronous: Boolean = false) extends GeneratedMessage with Message[SideEffect] with Updatable[SideEffect] with Product with Serializable

    A side effect to be done after this command is handled.

    A side effect to be done after this command is handled.

    serviceName

    The name of the service to perform the side effect on.

    commandName

    The name of the command.

    payload

    The payload of the command.

    synchronous

    Whether this side effect should be performed synchronously, ie, before the reply is eventually sent, or not.

    Annotations

    @SerialVersionUID()

12.  final case class StreamCancelled(entityId: String = "", id: Long = 0L) extends GeneratedMessage with Message[StreamCancelled] with Updatable[StreamCancelled] with Product with Serializable
    entityId

    The ID of the entity

    id

    The command id

    Annotations

    @SerialVersionUID()

13.  final case class UserFunctionError(message: String = "") extends GeneratedMessage with Message[UserFunctionError] with Updatable[UserFunctionError] with Product with Serializable

    Annotations

    @SerialVersionUID()