Class/Object

fs2.kafka

ProducerMessage

Related Docs: object ProducerMessage | package kafka

Permalink

sealed abstract class ProducerMessage[F[_], K, V, +P] extends AnyRef

ProducerMessage represents zero or more ProducerRecords, together with an arbitrary passthrough value, all of which can be used with KafkaProducer. ProducerMessages can be created using one of the following options.

- ProducerMessage#single to produce exactly one record and then emit a ProducerResult with the result and specified passthrough value.
- ProducerMessage#multiple to produce zero or more records and then emit a ProducerResult with the results and specified passthrough value.
- ProducerMessage#passthrough to produce exactly zero records, only emitting a ProducerResult with the specified passthrough value.

The passthrough and records can be retrieved from an existing ProducerMessage instance.

For a ProducerMessage to be usable by KafkaProducer, it needs a Traverse instance. This requirement is captured in ProducerMessage via traverse.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProducerMessage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def passthrough: P

    Permalink

    The passthrough to emit once all records have been produced.

  2. abstract def records: F[ProducerRecord[K, V]]

    Permalink

    The records to produce.

    The records to produce. Can be empty for passthrough-only.

  3. abstract def traverse: Traverse[F]

    Permalink

    The traverse instance for F[_].

    The traverse instance for F[_]. Required by KafkaProducer.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped