Packages

object BinaryAnnotation extends ValidatingThriftStructCodec3[BinaryAnnotation] with StructBuilderFactory[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, StructBuilderFactory[BinaryAnnotation], ValidatingThriftStructCodec3[BinaryAnnotation], ThriftStructCodec3[BinaryAnnotation], ThriftStructCodec[BinaryAnnotation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryAnnotation
  2. Serializable
  3. Serializable
  4. StructBuilderFactory
  5. ValidatingThriftStructCodec3
  6. ThriftStructCodec3
  7. ThriftStructCodec
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Immutable extends BinaryAnnotation

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val AnnotationTypeField: TField
  5. val AnnotationTypeFieldI32: TField
  6. val AnnotationTypeFieldManifest: Manifest[AnnotationType]
  7. val HostField: TField
  8. val HostFieldManifest: Manifest[Endpoint]
  9. val KeyField: TField
  10. val KeyFieldManifest: Manifest[String]
  11. val Struct: TStruct
  12. val ValueField: TField
  13. val ValueFieldManifest: Manifest[ByteBuffer]
  14. def apply(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint] = _root_.scala.None): BinaryAnnotation
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def decode(_iprot: TProtocol): BinaryAnnotation
    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  18. def encode(_item: BinaryAnnotation, _oproto: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. lazy val fieldInfos: List[ThriftStructFieldInfo]

    Field information in declaration order.

  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. lazy val metaData: ThriftStructMetaData[BinaryAnnotation]
    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def newBuilder(): StructBuilder[BinaryAnnotation]
    Definition Classes
    BinaryAnnotation → StructBuilderFactory
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. val structAnnotations: Map[String, String]
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def ttypeToString(byte: Byte): String
    Attributes
    protected
    Definition Classes
    ThriftStructCodec3
  35. def unapply(_item: BinaryAnnotation): Option[(String, ByteBuffer, AnnotationType, Option[Endpoint])]
  36. lazy val unsafeEmpty: BinaryAnnotation
  37. def validate(_item: BinaryAnnotation): Unit

    Checks that all required fields are non-null.

  38. final def validateField[U <: ValidatingThriftStruct[U]](any: Any): Seq[Issue]
    Attributes
    protected
    Definition Classes
    ValidatingThriftStructCodec3
  39. final def validateFieldValue[U <: ValidatingThriftStruct[U]](fieldName: String, fieldValue: Any, fieldAnnotations: Map[String, String], thriftValidator: ThriftValidator): Set[ThriftValidationViolation]
    Attributes
    protected
    Definition Classes
    ValidatingThriftStructCodec3
  40. def validateInstanceValue(item: BinaryAnnotation): Set[ThriftValidationViolation]

    Validate that all validation annotations on the struct meet the criteria defined in the corresponding com.twitter.scrooge.validation.ThriftConstraintValidator.

    Validate that all validation annotations on the struct meet the criteria defined in the corresponding com.twitter.scrooge.validation.ThriftConstraintValidator.

    Definition Classes
    BinaryAnnotation → ValidatingThriftStructCodec3
  41. def validateNewInstance(item: BinaryAnnotation): Seq[Issue]

    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
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. def withoutPassthroughFields(original: BinaryAnnotation): BinaryAnnotation
  46. object Immutable extends ThriftStructCodec3[BinaryAnnotation] with Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from StructBuilderFactory[BinaryAnnotation]

Inherited from ValidatingThriftStructCodec3[BinaryAnnotation]

Inherited from ThriftStructCodec3[BinaryAnnotation]

Inherited from ThriftStructCodec[BinaryAnnotation]

Inherited from AnyRef

Inherited from Any

Ungrouped