ConsumerSettings

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val closeTimeout: FiniteDuration

val commitRefreshInterval: Duration

val commitTimeWarning: FiniteDuration

val commitTimeout: FiniteDuration

val consumerFactory: (ConsumerSettings[K, V]) ⇒ Consumer[K, V]

def createKafkaConsumer(): Consumer[K, V]

Create a Kafka Consumer instance from these settings.

val dispatcher: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getCloseTimeout: Duration

def getMetadataRequestTimeout: Duration

def getOffsetForTimesTimeout: Duration

def getPositionTimeout: Duration

def getProperties: Map[String, AnyRef]

Get the Kafka consumer settings as map.

def getProperty(key: String): String

Java API: Get a raw property.

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val keyDeserializerOpt: Option[Deserializer[K]]

val metadataRequestTimeout: FiniteDuration

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val offsetForTimesTimeout: FiniteDuration

val pollInterval: FiniteDuration

val pollTimeout: FiniteDuration

val positionTimeout: FiniteDuration

val properties: Map[String, String]

val stopTimeout: FiniteDuration

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

def toString(): String

val valueDeserializerOpt: Option[Deserializer[V]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val waitClosePartition: FiniteDuration

def withBootstrapServers(bootstrapServers: String): ConsumerSettings[K, V]

A comma-separated list of host/port pairs to use for establishing the initial connection to the Kafka cluster.

def withClientId(clientId: String): ConsumerSettings[K, V]

An id string to pass to the server when making requests.

def withCloseTimeout(closeTimeout: Duration): ConsumerSettings[K, V]

Java API: Set duration to wait for KafkaConsumer.close to finish.

def withCloseTimeout(closeTimeout: FiniteDuration): ConsumerSettings[K, V]

Set duration to wait for KafkaConsumer.close to finish.

def withCommitRefreshInterval(commitRefreshInterval: Duration): ConsumerSettings[K, V]

Java API: If set to a finite duration, the consumer will re-send the last committed offsets periodically for all assigned partitions.

def withCommitRefreshInterval(commitRefreshInterval: Duration): ConsumerSettings[K, V]

If set to a finite duration, the consumer will re-send the last committed offsets periodically for all assigned partitions.

def withCommitTimeout(commitTimeout: Duration): ConsumerSettings[K, V]

Java API: If offset commit requests are not completed within this timeout the returned Future is completed with akka.kafka.CommitTimeoutException.

def withCommitTimeout(commitTimeout: FiniteDuration): ConsumerSettings[K, V]

If offset commit requests are not completed within this timeout the returned Future is completed with akka.kafka.CommitTimeoutException.

def withCommitWarning(commitTimeWarning: Duration): ConsumerSettings[K, V]

Java API: If commits take longer than this time a warning is logged

def withCommitWarning(commitTimeWarning: FiniteDuration): ConsumerSettings[K, V]

If commits take longer than this time a warning is logged

def withConsumerFactory(factory: (ConsumerSettings[K, V]) ⇒ Consumer[K, V]): ConsumerSettings[K, V]

Replaces the default Kafka consumer creation logic.

def withDispatcher(dispatcher: String): ConsumerSettings[K, V]

Fully qualified config path which holds the dispatcher configuration to be used by the akka.kafka.KafkaConsumerActor.

def withGroupId(groupId: String): ConsumerSettings[K, V]

A unique string that identifies the consumer group this consumer belongs to.

def withMetadataRequestTimeout(metadataRequestTimeout: Duration): ConsumerSettings[K, V]

Java API

def withMetadataRequestTimeout(metadataRequestTimeout: FiniteDuration): ConsumerSettings[K, V]

Scala API

def withOffsetForTimesTimeout(offsetForTimesTimeout: Duration): ConsumerSettings[K, V]

Java API: Limits the blocking on Kafka consumer offsetForTimes calls.

def withOffsetForTimesTimeout(offsetForTimesTimeout: FiniteDuration): ConsumerSettings[K, V]

Scala API: Limits the blocking on Kafka consumer offsetForTimes calls.

def withPollInterval(pollInterval: Duration): ConsumerSettings[K, V]

Java API: Set the interval from one scheduled poll to the next.

def withPollInterval(pollInterval: FiniteDuration): ConsumerSettings[K, V]

Set the interval from one scheduled poll to the next.

def withPollTimeout(pollTimeout: Duration): ConsumerSettings[K, V]

Java API: Set the maximum duration a poll to the Kafka broker is allowed to take.

def withPollTimeout(pollTimeout: FiniteDuration): ConsumerSettings[K, V]

Set the maximum duration a poll to the Kafka broker is allowed to take.

def withPositionTimeout(positionTimeout: Duration): ConsumerSettings[K, V]

Java API: Limits the blocking on Kafka consumer position calls.

def withPositionTimeout(positionTimeout: FiniteDuration): ConsumerSettings[K, V]

Scala API: Limits the blocking on Kafka consumer position calls.

def withProperties(properties: Map[String, String]): ConsumerSettings[K, V]

Java API: The raw properties of the kafka-clients driver, see constants in org.apache.kafka.clients.consumer.ConsumerConfig.

def withProperties(properties: (String, String)*): ConsumerSettings[K, V]

Scala API: The raw properties of the kafka-clients driver, see constants in org.apache.kafka.clients.consumer.ConsumerConfig.

def withProperties(properties: Map[String, String]): ConsumerSettings[K, V]

Scala API: The raw properties of the kafka-clients driver, see constants in org.apache.kafka.clients.consumer.ConsumerConfig.

def withProperty(key: String, value: String): ConsumerSettings[K, V]

The raw properties of the kafka-clients driver, see constants in org.apache.kafka.clients.consumer.ConsumerConfig.

def withStopTimeout(stopTimeout: Duration): ConsumerSettings[K, V]

Java API: The stage will await outstanding offset commit requests before shutting down, but if that takes longer than this timeout it will stop forcefully.

def withStopTimeout(stopTimeout: FiniteDuration): ConsumerSettings[K, V]

The stage will await outstanding offset commit requests before shutting down, but if that takes longer than this timeout it will stop forcefully.

def withWaitClosePartition(waitClosePartition: Duration): ConsumerSettings[K, V]

Java API: Time to wait for pending requests when a partition is closed.

def withWaitClosePartition(waitClosePartition: FiniteDuration): ConsumerSettings[K, V]

Time to wait for pending requests when a partition is closed.

def withMaxWakeups(maxWakeups: Int): ConsumerSettings[K, V]

Not used anymore

def withWakeupDebug(wakeupDebug: Boolean): ConsumerSettings[K, V]

Not used anymore

def withWakeupTimeout(wakeupTimeout: Duration): ConsumerSettings[K, V]

Java API: Not used anymore

def withWakeupTimeout(wakeupTimeout: FiniteDuration): ConsumerSettings[K, V]

Not used anymore