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.
- Alphabetic
- By Inheritance
- BinaryAnnotation
- Serializable
- StructBuilderFactory
- ValidatingThriftStructCodec3
- ThriftStructCodec3
- ThriftStructCodec
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val AnnotationTypeField: TField
- val AnnotationTypeFieldI32: TField
- val AnnotationTypeFieldManifest: Manifest[AnnotationType]
- val HostField: TField
- val HostFieldManifest: Manifest[Endpoint]
- val KeyField: TField
- val KeyFieldManifest: Manifest[String]
- val Struct: TStruct
- val ValueField: TField
- val ValueFieldManifest: Manifest[ByteBuffer]
- def apply(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint] = _root_.scala.None): BinaryAnnotation
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def decode(_iprot: TProtocol): BinaryAnnotation
- Definition Classes
- BinaryAnnotation → ThriftStructCodec
- def encode(_item: BinaryAnnotation, _oproto: TProtocol): Unit
- Definition Classes
- BinaryAnnotation → ThriftStructCodec
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- lazy val fieldInfos: List[ThriftStructFieldInfo]
Field information in declaration order.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val metaData: ThriftStructMetaData[BinaryAnnotation]
- Definition Classes
- BinaryAnnotation → ThriftStructCodec
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilder(): StructBuilder[BinaryAnnotation]
- Definition Classes
- BinaryAnnotation → StructBuilderFactory
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val structAnnotations: Map[String, String]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def ttypeToString(byte: Byte): String
- Attributes
- protected
- Definition Classes
- ThriftStructCodec3
- def unapply(_item: BinaryAnnotation): Option[(String, ByteBuffer, AnnotationType, Option[Endpoint])]
- lazy val unsafeEmpty: BinaryAnnotation
- def validate(_item: BinaryAnnotation): Unit
Checks that all required fields are non-null.
- final def validateField[U <: ValidatingThriftStruct[U]](any: Any): Seq[Issue]
- Attributes
- protected
- Definition Classes
- ValidatingThriftStructCodec3
- final def validateFieldValue[U <: ValidatingThriftStruct[U]](fieldName: String, fieldValue: Any, fieldAnnotations: Map[String, String], thriftValidatorOpt: Option[ThriftValidator]): Set[ThriftValidationViolation]
- Attributes
- protected
- Definition Classes
- ValidatingThriftStructCodec3
- 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
- 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
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withoutPassthroughFields(original: BinaryAnnotation): BinaryAnnotation
- object Immutable extends ThriftStructCodec3[BinaryAnnotation] with Serializable