ProducerMessage

akka.kafka.ProducerMessage$

Classes that are used in both javadsl.Producer and scaladsl.Producer.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

sealed trait Envelope[K, V, +PassThrough]

Type accepted by Producer.committableSink and Producer.flexiFlow with implementations

Type accepted by Producer.committableSink and Producer.flexiFlow with implementations

The passThrough field may hold any element that is passed through the Producer.flexiFlow and included in the Results. That is useful when some context is needed to be passed on downstream operations. That could be done with unzip/zip, but this is more convenient. It can for example be a ConsumerMessage.CommittableOffset or ConsumerMessage.CommittableOffsetBatch that can be committed later in the flow.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Message[K, V, PassThrough]
class MultiMessage[K, V, PassThrough]
class PassThroughMessage[K, V, PassThrough]
final case class Message[K, V, +PassThrough](record: ProducerRecord[K, V], passThrough: PassThrough) extends Envelope[K, V, PassThrough]

Envelope implementation that produces a single message to a Kafka topic, flows emit a Result for every element processed.

Envelope implementation that produces a single message to a Kafka topic, flows emit a Result for every element processed.

The record contains a topic name to which the record is being sent, an optional partition number, and an optional key and value.

The passThrough field may hold any element that is passed through the Producer.flow and included in the Result. That is useful when some context is needed to be passed on downstream operations. That could be done with unzip/zip, but this is more convenient. It can for example be a ConsumerMessage.CommittableOffset or ConsumerMessage.CommittableOffsetBatch that can be committed later in the flow.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Envelope[K, V, PassThrough]
class Object
trait Matchable
class Any
final case class MultiMessage[K, V, +PassThrough](records: Seq[ProducerRecord[K, V]], passThrough: PassThrough) extends Envelope[K, V, PassThrough]

Envelope implementation that produces multiple message to a Kafka topics, flows emit a MultiResult for every element processed.

Envelope implementation that produces multiple message to a Kafka topics, flows emit a MultiResult for every element processed.

Every element in records contains a topic name to which the record is being sent, an optional partition number, and an optional key and value.

The passThrough field may hold any element that is passed through the Producer.flow and included in the MultiResult. That is useful when some context is needed to be passed on downstream operations. That could be done with unzip/zip, but this is more convenient. It can for example be a ConsumerMessage.CommittableOffset or ConsumerMessage.CommittableOffsetBatch that can be committed later in the flow.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Envelope[K, V, PassThrough]
class Object
trait Matchable
class Any
final case class MultiResult[K, V, PassThrough] extends Results[K, V, PassThrough]

Results implementation emitted when all messages in a MultiMessage have been successfully published.

Results implementation emitted when all messages in a MultiMessage have been successfully published.

Attributes

Companion:
object
Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Results[K, V, PassThrough]
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
ProducerMessage.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class MultiResultPart[K, V]

Attributes

Companion:
object
Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
ProducerMessage.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PassThroughMessage[K, V, +PassThrough](passThrough: PassThrough) extends Envelope[K, V, PassThrough]

Envelope implementation that does not produce anything to Kafka, flows emit a PassThroughResult for every element processed.

Envelope implementation that does not produce anything to Kafka, flows emit a PassThroughResult for every element processed.

The passThrough field may hold any element that is passed through the Producer.flow and included in the Results. That is useful when some context is needed to be passed on downstream operations. That could be done with unzip/zip, but this is more convenient. It can for example be a ConsumerMessage.CommittableOffset or ConsumerMessage.CommittableOffsetBatch that can be committed later in the flow.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Envelope[K, V, PassThrough]
class Object
trait Matchable
class Any
final case class PassThroughResult[K, V, PassThrough] extends Results[K, V, PassThrough]

Results implementation emitted when a PassThroughMessage has passed through the flow.

Results implementation emitted when a PassThroughMessage has passed through the flow.

Attributes

Companion:
object
Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Results[K, V, PassThrough]
class Object
trait Matchable
class Any

Attributes

Companion:
class
Source:
ProducerMessage.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Result[K, V, PassThrough] extends Results[K, V, PassThrough]

Results implementation emitted when a Message has been successfully published.

Results implementation emitted when a Message has been successfully published.

Includes the original message, metadata returned from KafkaProducer and the offset of the produced message.

Attributes

Companion:
object
Source:
ProducerMessage.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Results[K, V, PassThrough]
class Object
trait Matchable
class Any
object Result

Attributes

Companion:
class
Source:
ProducerMessage.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Result.type
sealed trait Results[K, V, PassThrough]

Output type produced by Producer.flexiFlow and Transactional.flow.

Output type produced by Producer.flexiFlow and Transactional.flow.

Attributes

Source:
ProducerMessage.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MultiResult[K, V, PassThrough]
class PassThroughResult[K, V, PassThrough]
class Result[K, V, PassThrough]

Value members

Concrete methods

def multi[K, V, PassThrough](records: Seq[ProducerRecord[K, V]], passThrough: PassThrough): Envelope[K, V, PassThrough]

Create a multi-message containing several records and one passThrough.

Create a multi-message containing several records and one passThrough.

Attributes

K

the type of keys

PassThrough

the type of data passed through

V

the type of values

Source:
ProducerMessage.scala
def multi[K, V](records: Seq[ProducerRecord[K, V]]): Envelope[K, V, NotUsed]

Create a multi-message containing several records.

Create a multi-message containing several records.

Attributes

K

the type of keys

V

the type of values

Source:
ProducerMessage.scala
def multi[K, V, PassThrough](records: Collection[ProducerRecord[K, V]], passThrough: PassThrough): Envelope[K, V, PassThrough]

Java API: Create a multi-message containing several records and one passThrough.

Java API: Create a multi-message containing several records and one passThrough.

Attributes

K

the type of keys

PassThrough

the type of data passed through

V

the type of values

Source:
ProducerMessage.scala
def multi[K, V](records: Collection[ProducerRecord[K, V]]): Envelope[K, V, NotUsed]

Java API: Create a multi-message containing several records.

Java API: Create a multi-message containing several records.

Attributes

K

the type of keys

V

the type of values

Source:
ProducerMessage.scala
def passThrough[K, V, PassThrough](passThrough: PassThrough): Envelope[K, V, PassThrough]

Create a pass-through message not containing any records. In some cases the type parameters need to be specified explicitly.

Create a pass-through message not containing any records. In some cases the type parameters need to be specified explicitly.

Attributes

K

the type of keys

PassThrough

the type of data passed through

V

the type of values

Source:
ProducerMessage.scala
def passThrough[K, V](): Envelope[K, V, NotUsed]

Create a pass-through message not containing any records for use with withContext flows and sinks. In some cases the type parameters need to be specified explicitly.

Create a pass-through message not containing any records for use with withContext flows and sinks. In some cases the type parameters need to be specified explicitly.

Attributes

K

the type of keys

V

the type of values

Source:
ProducerMessage.scala
def single[K, V, PassThrough](record: ProducerRecord[K, V], passThrough: PassThrough): Envelope[K, V, PassThrough]

Create a message containing the record and a passThrough.

Create a message containing the record and a passThrough.

Attributes

K

the type of keys

PassThrough

the type of data passed through

V

the type of values

Source:
ProducerMessage.scala
def single[K, V](record: ProducerRecord[K, V]): Envelope[K, V, NotUsed]

Create a message containing the record.

Create a message containing the record.

Attributes

K

the type of keys

V

the type of values

Source:
ProducerMessage.scala