Class/Object

kafka.consumer

ConsumerConfig

Related Docs: object ConsumerConfig | package consumer

Permalink

class ConsumerConfig extends ZKConfig

Linear Supertypes
ZKConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConsumerConfig
  2. ZKConfig
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsumerConfig(originalProps: Properties)

    Permalink

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. val autoCommitEnable: Boolean

    Permalink

    if true, periodically commit to zookeeper the offset of messages already fetched by the consumer

  6. val autoCommitIntervalMs: Int

    Permalink

    the frequency in ms that the consumer offsets are committed to zookeeper

  7. val autoOffsetReset: String

    Permalink
  8. val clientId: String

    Permalink

    Client id is specified by the kafka consumer client, used to distinguish different clients

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val consumerId: Option[String]

    Permalink

    consumer id: generated automatically if not set.

    consumer id: generated automatically if not set. Set this explicitly for only testing purpose.

  11. val consumerTimeoutMs: Int

    Permalink

    throw a timeout exception to the consumer if no message is available for consumption after the specified interval

  12. val dualCommitEnabled: Boolean

    Permalink

    If you are using "kafka" as offsets.storage, you can dual commit offsets to ZooKeeper (in addition to Kafka).

    If you are using "kafka" as offsets.storage, you can dual commit offsets to ZooKeeper (in addition to Kafka). This is required during migration from zookeeper-based offset storage to kafka-based offset storage. With respect to any given consumer group, it is safe to turn this off after all instances within that group have been migrated to the new jar that commits offsets to the broker (instead of directly to ZooKeeper).

  13. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. val excludeInternalTopics: Boolean

    Permalink

    Whether messages from internal topics (such as offsets) should be exposed to the consumer.

  16. val fetchMessageMaxBytes: Int

    Permalink

    the number of byes of messages to attempt to fetch

  17. val fetchMinBytes: Int

    Permalink

    the minimum amount of data the server should return for a fetch request.

    the minimum amount of data the server should return for a fetch request. If insufficient data is available the request will block

  18. val fetchWaitMaxMs: Int

    Permalink

    the maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy fetch.min.bytes

  19. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. val groupId: String

    Permalink

    a string that uniquely identifies a set of consumers within the same consumer group

  22. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  27. val numConsumerFetchers: Int

    Permalink

    the number threads used to fetch data

  28. val offsetsChannelBackoffMs: Int

    Permalink

    backoff time to reconnect the offsets channel or to retry offset fetches/commits

  29. val offsetsChannelSocketTimeoutMs: Int

    Permalink

    socket timeout to use when reading responses for Offset Fetch/Commit requests.

    socket timeout to use when reading responses for Offset Fetch/Commit requests. This timeout will also be used for the ConsumerMetdata requests that are used to query for the offset coordinator.

  30. val offsetsCommitMaxRetries: Int

    Permalink

    Retry the offset commit up to this many times on failure.

    Retry the offset commit up to this many times on failure. This retry count only applies to offset commits during shut-down. It does not apply to commits from the auto-commit thread. It also does not apply to attempts to query for the offset coordinator before committing offsets. i.e., if a consumer metadata request fails for any reason, it is retried and that retry does not count toward this limit.

  31. val offsetsStorage: String

    Permalink

    Specify whether offsets should be committed to "zookeeper" (default) or "kafka"

  32. val partitionAssignmentStrategy: String

    Permalink

    Select a strategy for assigning partitions to consumer streams.

    Select a strategy for assigning partitions to consumer streams. Possible values: range, roundrobin

  33. val props: VerifiableProperties

    Permalink
  34. val queuedMaxMessages: Int

    Permalink

    max number of message chunks buffered for consumption, each chunk can be up to fetch.message.max.bytes

  35. val rebalanceBackoffMs: Int

    Permalink

    backoff time between retries during rebalance

  36. val rebalanceMaxRetries: Int

    Permalink

    max number of retries during rebalance

  37. val refreshLeaderBackoffMs: Int

    Permalink

    backoff time to refresh the leader of a partition after it loses the current leader

  38. val socketReceiveBufferBytes: Int

    Permalink

    the socket receive buffer for network requests

  39. val socketTimeoutMs: Int

    Permalink

    the socket timeout for network requests.

    the socket timeout for network requests. Its value should be at least fetch.wait.max.ms.

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. val zkConnect: String

    Permalink

    ZK host string

    ZK host string

    Definition Classes
    ZKConfig
  46. val zkConnectionTimeoutMs: Int

    Permalink

    the max time that the client waits to establish a connection to zookeeper

    the max time that the client waits to establish a connection to zookeeper

    Definition Classes
    ZKConfig
  47. val zkSessionTimeoutMs: Int

    Permalink

    zookeeper session timeout

    zookeeper session timeout

    Definition Classes
    ZKConfig
  48. val zkSyncTimeMs: Int

    Permalink

    how far a ZK follower can be behind a ZK leader

    how far a ZK follower can be behind a ZK leader

    Definition Classes
    ZKConfig

Inherited from ZKConfig

Inherited from AnyRef

Inherited from Any

Ungrouped