Object/Trait

com.twitter.finagle.thrift.thriftscala

BinaryAnnotation

Related Docs: trait BinaryAnnotation | package thriftscala

Permalink

object BinaryAnnotation extends ValidatingThriftStructCodec3[BinaryAnnotation] with Serializable

Binary annotations are tags applied to a Span to give it context. For example, a binary annotation of "http.uri" could the path to a resource in a RPC call.

Binary annotations of type STRING are always queryable, though more a historical implementation detail than a structural concern.

Binary annotations can repeat, and vary on the host. Similar to Annotation, the host indicates who logged the event. This allows you to tell the difference between the client and server side of the same key. For example, the key "http.uri" might be different on the client and server side due to rewriting, like "/api/v1/myresource" vs "/myresource. Via the host field, you can see the different points of view, which often help in debugging.

Linear Supertypes
Serializable, Serializable, ValidatingThriftStructCodec3[BinaryAnnotation], ThriftStructCodec3[BinaryAnnotation], ThriftStructCodec[BinaryAnnotation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryAnnotation
  2. Serializable
  3. Serializable
  4. ValidatingThriftStructCodec3
  5. ThriftStructCodec3
  6. ThriftStructCodec
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Immutable extends BinaryAnnotation

    Permalink

    The default read-only implementation of BinaryAnnotation.

    The default read-only implementation of BinaryAnnotation. You typically should not need to directly reference this class; instead, use the BinaryAnnotation.apply method to construct new instances.

  2. trait Proxy extends BinaryAnnotation

    Permalink

    This Proxy trait allows you to extend the BinaryAnnotation trait with additional state or behavior and implement the read-only methods from BinaryAnnotation using an underlying instance.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val AnnotationTypeField: TField

    Permalink
  5. val AnnotationTypeFieldI32: TField

    Permalink
  6. val AnnotationTypeFieldManifest: Manifest[AnnotationType]

    Permalink
  7. val HostField: TField

    Permalink
  8. val HostFieldManifest: Manifest[Endpoint]

    Permalink
  9. object Immutable extends ThriftStructCodec3[BinaryAnnotation] with Serializable

    Permalink
  10. val KeyField: TField

    Permalink
  11. val KeyFieldManifest: Manifest[String]

    Permalink
  12. val NoPassthroughFields: Map[Short, TFieldBlob]

    Permalink
  13. val Struct: TStruct

    Permalink
  14. val ValueField: TField

    Permalink
  15. val ValueFieldManifest: Manifest[ByteBuffer]

    Permalink
  16. def apply(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint] = _root_.scala.None): BinaryAnnotation

    Permalink
  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def decode(_iprot: TProtocol): BinaryAnnotation

    Permalink
    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  20. def encode(_item: BinaryAnnotation, _oproto: TProtocol): Unit

    Permalink
    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. lazy val fieldInfos: List[ThriftStructFieldInfo]

    Permalink

    Field information in declaration order.

  24. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  28. lazy val metaData: ThriftStructMetaData[BinaryAnnotation]

    Permalink
    Definition Classes
    ThriftStructCodec
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. lazy val structAnnotations: Map[String, String]

    Permalink
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. def ttypeToString(byte: Byte): String

    Permalink
    Attributes
    protected
    Definition Classes
    ThriftStructCodec3
  36. def unapply(_item: BinaryAnnotation): Option[(String, ByteBuffer, AnnotationType, Option[Endpoint])]

    Permalink
  37. def validate(_item: BinaryAnnotation): Unit

    Permalink

    Checks that all required fields are non-null.

  38. final def validateField[U <: ValidatingThriftStruct[U]](any: Any): Seq[Issue]

    Permalink
    Attributes
    protected
    Definition Classes
    ValidatingThriftStructCodec3
  39. def validateNewInstance(item: BinaryAnnotation): Seq[Issue]

    Permalink

    Checks that the struct is a valid as a new instance.

    Checks that the struct is a valid as a new instance. If there are any missing required or construction required fields, return a non-empty list.

    Definition Classes
    BinaryAnnotation → ValidatingThriftStructCodec3
  40. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def withoutPassthroughFields(original: BinaryAnnotation): BinaryAnnotation

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from ValidatingThriftStructCodec3[BinaryAnnotation]

Inherited from ThriftStructCodec3[BinaryAnnotation]

Inherited from ThriftStructCodec[BinaryAnnotation]

Inherited from AnyRef

Inherited from Any

Ungrouped