com.gensler.scalavro.protocol

AvroProtocol

case class AvroProtocol(protocol: String, types: Seq[AvroNamedType[_]], messages: Map[String, Message], namespace: Option[String] = scala.None, doc: Option[String] = scala.None) extends JsonSchemifiable with CanonicalForm with Product with Serializable

Avro protocols describe RPC interfaces. Like schemas, they are defined with JSON text.

A protocol is a JSON object with the following attributes:

protocol, a string, the name of the protocol (required);

namespace, an optional string that qualifies the name;

doc, an optional string describing this protocol;

types, an optional list of definitions of named types (records, enums, fixed and errors). An error definition is just like a record definition except it uses "error" instead of "record". Note that forward references to named types are not permitted.

messages, an optional JSON object whose keys are message names and whose values are objects whose attributes are described below. No two messages may have the same name.

The name and namespace qualification rules defined for schema objects apply to protocols as well.

Linear Supertypes
Serializable, Serializable, Product, Equals, CanonicalForm, JsonSchemifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AvroProtocol
  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 AvroProtocol(protocol: String, types: Seq[AvroNamedType[_]], messages: Map[String, Message], namespace: Option[String] = scala.None, doc: Option[String] = 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. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final lazy val fingerprint: Array[Byte]

    Returns the result of computing MD5 over this protocol's parsing canonical form.

  12. final def getClass(): Class[_]

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

    Definition Classes
    Any
  14. val messages: Map[String, Message]

  15. val namespace: Option[String]

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. lazy val normalizedDeclarations: Seq[AvroType[_]]

  18. final def notify(): Unit

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

    Definition Classes
    AnyRef
  20. def parsingCanonicalForm(): JsValue

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

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

    Definition Classes
    AvroProtocolCanonicalForm
  21. val protocol: String

  22. def schema(): JsValue

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

    Definition Classes
    AnyRef
  24. val types: Seq[AvroNamedType[_]]

  25. final def wait(): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. 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