fs2-kafka
3.7.0-RC2
API
Generated with
fs2-kafka/fs2.kafka/Header

Header

fs2.kafka.Header
See theHeader companion object
sealed abstract class Header extends Header

Header represents a String key and Array[Byte] value which can be included as part of Headers when creating a ProducerRecord. Headers are included together with a record once produced, and can be used by consumers.

To create a new Header, use Header#apply.

Attributes

Companion
object
Source
Header.scala
Graph
Supertypes
trait Header
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

override def key: String

The header key.

The header key.

Attributes

Definition Classes
Header
Source
Header.scala
override def value: Array[Byte]

The serialized header value.

The serialized header value.

Attributes

Definition Classes
Header
Source
Header.scala

Concrete methods

final def as[A](implicit deserializer: HeaderDeserializer[A]): A

Deserializes the value to the specified type.

Deserializes the value to the specified type.

Attributes

Source
Header.scala
final def attemptAs[A](implicit deserializer: Attempt[A]): Either[Throwable, A]

Attempts to deserialize the value to the specified type.

Attempts to deserialize the value to the specified type.

Attributes

Source
Header.scala
Generated with