com.gensler.scalavro.protocol.AvroProtocol

Message

case class Message(request: AvroRecord[_], response: AvroType[_], errors: Option[AvroUnion[_, _]] = scala.None, doc: Option[String] = scala.None, oneWay: Option[Boolean] = scala.None) extends JsonSchemifiable with CanonicalForm with Product with Serializable

A message has attributes:

a doc, an optional description of the message,

a request, a list of named, typed parameter schemas (this has the same form as the fields of a record declaration);

a response schema;

an optional union of declared error schemas. The effective union has "string" prepended to the declared union, to permit transmission of undeclared "system" errors. For example, if the declared error union is ["AccessError"], then the effective union is ["string", "AccessError"]. When no errors are declared, the effective error union is ["string"]. Errors are serialized using the effective union; however, a protocol's JSON declaration contains only the declared union.

an optional one-way boolean parameter.

A request parameter list is processed equivalently to an anonymous record. Since record field lists may vary between reader and writer, request parameters may also differ between the caller and responder, and such differences are resolved in the same manner as record field differences.

The one-way parameter may only be true when the response type is "null" and no errors are listed.

Linear Supertypes
Serializable, Serializable, Product, Equals, CanonicalForm, JsonSchemifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Message
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CanonicalForm
  7. JsonSchemifiable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Message(request: AvroRecord[_], response: AvroType[_], errors: Option[AvroUnion[_, _]] = scala.None, doc: Option[String] = scala.None, oneWay: Option[Boolean] = scala.None)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val doc: Option[String]

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. val errors: Option[AvroUnion[_, _]]

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

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

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. val oneWay: Option[Boolean]

  18. def parsingCanonicalForm(): JsValue

    Returns the JSON schema for this message in "parsing canonical form".

    Returns the JSON schema for this message in "parsing canonical form".

    Definition Classes
    MessageCanonicalForm
  19. val request: AvroRecord[_]

  20. def requestParameters: Map[String, AvroType[_]]

  21. val response: AvroType[_]

  22. def schema(): JsValue

    Definition Classes
    MessageJsonSchemifiable
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CanonicalForm

Inherited from JsonSchemifiable

Inherited from AnyRef

Inherited from Any

Ungrouped