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.

Linear Supertypes

org.apache.kafka.common.header.Header, AnyRef, Any

Abstract Value Members

abstract def key(): String

The header key.
The header key.

Definition Classes
Header → Header
abstract def value(): Array[Byte]

The serialized header value.
The serialized header value.

Definition Classes
Header → Header

Concrete 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
final def as[A](implicit deserializer: HeaderDeserializer[A]): A

Deserializes the value to the specified type.
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def attemptAs[A](implicit deserializer: HeaderDeserializer[Either[Throwable, A]]): Either[Throwable, A]

Attempts to deserialize the value to the specified type.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def headers: Headers

Creates a new Headers instance with this header included.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Header | package kafka

sealed abstract class Header extends org.apache.kafka.common.header.Header

Abstract Value Members

abstract def key(): String

abstract def value(): Array[Byte]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

final def attemptAs[A](implicit deserializer: HeaderDeserializer[Either[Throwable, A]]): Either[Throwable, A]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def headers: Headers

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from org.apache.kafka.common.header.Header

Inherited from AnyRef

Inherited from Any

Ungrouped