kafka.consumer

ConsumerConfig

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsumerConfig(originalProps: Properties)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val autoCommitEnable: Boolean

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

  8. val autoCommitIntervalMs: Int

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

  9. val autoOffsetReset: String

  10. val clientId: String

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

  11. def clone(): AnyRef

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

    consumer id: generated automatically if not set.

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

  13. val consumerTimeoutMs: Int

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

  14. val dualCommitEnabled: Boolean

    If you are using "kafka" as offsets.

    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).

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

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

    Definition Classes
    AnyRef → Any
  17. val excludeInternalTopics: Boolean

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

  18. val fetchMessageMaxBytes: Int

    the number of byes of messages to attempt to fetch

  19. val fetchMinBytes: Int

    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

  20. val fetchWaitMaxMs: Int

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

    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

  21. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  23. val groupId: String

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

  24. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. val numConsumerFetchers: Int

    the number threads used to fetch data

  30. val offsetsChannelBackoffMs: Int

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

  31. val offsetsChannelSocketTimeoutMs: Int

    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.

  32. val offsetsCommitMaxRetries: Int

    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.

  33. val offsetsStorage: String

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

  34. val partitionAssignmentStrategy: String

    Select a strategy for assigning partitions to consumer streams.

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

  35. val props: VerifiableProperties

  36. val queuedMaxMessages: Int

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

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

  37. val rebalanceBackoffMs: Int

    backoff time between retries during rebalance

  38. val rebalanceMaxRetries: Int

    max number of retries during rebalance

  39. val refreshLeaderBackoffMs: Int

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

  40. val socketReceiveBufferBytes: Int

    the socket receive buffer for network requests

  41. val socketTimeoutMs: Int

    the socket timeout for network requests.

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

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

    Definition Classes
    AnyRef
  43. def toString(): String

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

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

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

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

    ZK host string

    ZK host string

    Definition Classes
    ZKConfig
  48. val zkConnectionTimeoutMs: Int

    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
  49. val zkSessionTimeoutMs: Int

    zookeeper session timeout

    zookeeper session timeout

    Definition Classes
    ZKConfig
  50. val zkSyncTimeMs: Int

    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