Packages

final case class Command(entityId: String = "", id: Long = 0L, name: String = "", payload: Option[Any] = _root_.scala.None, metadata: Option[Metadata] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Command] with Product with Serializable

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

entityId

The ID of the entity instance this command is addressed to

id

A command id.

name

Command name

payload

The command payload.

metadata

The command metadata. Not all transports support per message metadata, for example, gRPC doesn't. The Kalix proxy MAY include metadata from other locations in this case, for example, in gRPC, a unary call MAY have the HTTP request headers attached to the command, while a streamed call MAY have the HTTP request headers attached as the metadata for either the first command, or every command. This specification leaves this behavior undefined.

Annotations
@SerialVersionUID()
Source
Command.scala
Linear Supertypes
Updatable[Command], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Command
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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

Instance Constructors

  1. new Command(entityId: String = "", id: Long = 0L, name: String = "", payload: Option[Any] = _root_.scala.None, metadata: Option[Metadata] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    entityId

    The ID of the entity instance this command is addressed to

    id

    A command id.

    name

    Command name

    payload

    The command payload.

    metadata

    The command metadata. Not all transports support per message metadata, for example, gRPC doesn't. The Kalix proxy MAY include metadata from other locations in this case, for example, in gRPC, a unary call MAY have the HTTP request headers attached to the command, while a streamed call MAY have the HTTP request headers attached as the metadata for either the first command, or every command. This specification leaves this behavior undefined.

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 Command toany2stringadd[Command] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Command, B)
    Implicit
    This member is added by an implicit conversion from Command toArrowAssoc[Command] 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 clearMetadata: Command
  8. def clearPayload: Command
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def companion: Command.type
    Definition Classes
    Command → GeneratedMessage
  11. def discardUnknownFields: Command
  12. def ensuring(cond: (Command) => Boolean, msg: => Any): Command
    Implicit
    This member is added by an implicit conversion from Command toEnsuring[Command] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Command) => Boolean): Command
    Implicit
    This member is added by an implicit conversion from Command toEnsuring[Command] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Command
    Implicit
    This member is added by an implicit conversion from Command toEnsuring[Command] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Command
    Implicit
    This member is added by an implicit conversion from Command toEnsuring[Command] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. val entityId: String
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Command → GeneratedMessage
  20. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Command → GeneratedMessage
  21. def getMetadata: Metadata
  22. def getPayload: Any
  23. val id: Long
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val metadata: Option[Metadata]
  26. val name: String
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val payload: Option[Any]
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. def serializedSize: Int
    Definition Classes
    Command → GeneratedMessage
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  35. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  36. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  37. def toProtoString: String
    Definition Classes
    Command → GeneratedMessage
  38. val unknownFields: UnknownFieldSet
  39. def update(ms: (Lens[Command, Command]) => Mutation[Command]*): Command
    Definition Classes
    Updatable
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. def withEntityId(__v: String): Command
  44. def withId(__v: Long): Command
  45. def withMetadata(__v: Metadata): Command
  46. def withName(__v: String): Command
  47. def withPayload(__v: Any): Command
  48. def withUnknownFields(__v: UnknownFieldSet): Command
  49. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  50. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Command → GeneratedMessage
  51. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

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 Command toStringFormat[Command] 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): (Command, B)
    Implicit
    This member is added by an implicit conversion from Command toArrowAssoc[Command] 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 Updatable[Command]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCommand to any2stringadd[Command]

Inherited by implicit conversion StringFormat fromCommand to StringFormat[Command]

Inherited by implicit conversion Ensuring fromCommand to Ensuring[Command]

Inherited by implicit conversion ArrowAssoc fromCommand to ArrowAssoc[Command]

Ungrouped