trait Metadata extends AnyRef

Immutable representation of the metadata in a call

Not for user extension

Annotations
@ApiMayChange() @DoNotInherit()
Source
Metadata.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
EntryMetadataImpl, GrpcMetadataImpl, HeaderMetadataImpl, HttpMessageMetadataImpl, RichGrpcMetadataImpl, MetadataStatus
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Metadata
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def asList: List[(String, MetadataEntry)]

    returns

    A list of (key, MetadataEntry) tuples.

    Annotations
    @ApiMayChange()
  2. abstract def asMap: Map[String, List[MetadataEntry]]

    returns

    The metadata as a map.

    Annotations
    @ApiMayChange()
  3. abstract def attribute[T](key: AttributeKey[T]): Option[T]

    Get an attribute from the underlying akka-http message associated with this metadata.

    Get an attribute from the underlying akka-http message associated with this metadata.

    Will return None if this metadata is not associated with an akka-http request or response, for example, if using the netty client support.

  4. abstract def getBinary(key: String): Option[ByteString]

    returns

    The binary header value for key if one exists, if the same key has multiple values the last occurrence that is a text key is used.

  5. abstract def getText(key: String): Option[String]

    returns

    The text header value for key if one exists, if the same key has multiple values the last occurrence that is a text key is used.