ConsumerConfigBuilder (kafka-config 1.0.1 API)

java.lang.Object
- net.soundvibe.kafka.config.AbstractConfigBuilder<ConsumerConfigBuilder>
- - net.soundvibe.kafka.config.consumer.ConsumerConfigBuilder

All Implemented Interfaces:: ConfigBuilder

public final class ConsumerConfigBuilder
extends AbstractConfigBuilder<ConsumerConfigBuilder>

Field Summary
- Fields inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder
  props

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConsumerConfigBuilder`	`create()`
`ConsumerConfigBuilder`	`withAllowAutoCreateTopics(boolean allowAutoCreateTopics)` Allow automatic topic creation on the broker when subscribing to or assigning a topic.
`ConsumerConfigBuilder`	`withAutoCommitInterval(Duration autoCommitInterval)` The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if `enable.auto.commit` is set to `true`.
`ConsumerConfigBuilder`	`withAutoOffsetReset(org.apache.kafka.clients.consumer.OffsetResetStrategy autoOffsetReset)` What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g.
`ConsumerConfigBuilder`	`withCheckCRCs(boolean checkCRCs)` Automatically check the CRC32 of the records consumed.
`ConsumerConfigBuilder`	`withDefaultApiTimeout(Duration defaultApiTimeout)` Specifies the timeout for consumer APIs that could block.
`ConsumerConfigBuilder`	`withEnableAutoCommit(boolean enableAutoCommit)` If true the consumer's offset will be periodically committed in the background.
`ConsumerConfigBuilder`	`withExcludeInternalTopics(boolean excludeInternalTopics)` Whether internal topics matching a subscribed pattern should be excluded from the subscription.
`ConsumerConfigBuilder`	`withFetchMaxBytes(int fetchMaxBytes)` The maximum amount of data the server should return for a fetch request.
`ConsumerConfigBuilder`	`withFetchMaxWait(Duration fetchMaxWait)` The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes.
`ConsumerConfigBuilder`	`withFetchMinBytes(int fetchMinBytes)` The minimum amount of data the server should return for a fetch request.
`ConsumerConfigBuilder`	`withGroupId(String groupId)` A unique string that identifies the consumer group this consumer belongs to.
`ConsumerConfigBuilder`	`withGroupInstanceId(String groupInstanceId)` A unique identifier of the consumer instance provided by end user.
`ConsumerConfigBuilder`	`withHeartbeatInterval(Duration heartbeatInterval)` The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities.
`ConsumerConfigBuilder`	`withInterceptorClasses(Class<? extends org.apache.kafka.clients.consumer.ConsumerInterceptor>... interceptorClasses)` A list of classes to use as interceptors.
`ConsumerConfigBuilder`	`withIsolationLevel(org.apache.kafka.common.requests.IsolationLevel isolationLevel)` Controls how to read messages written transactionally.
`ConsumerConfigBuilder`	`withKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<?> keyDeserializer)` Deserializer class for key that implements the `org.apache.kafka.common.serialization.Deserializer` interface.
`ConsumerConfigBuilder`	`withMaxPartitionFetchBytes(int maxPartitionFetchBytes)` The maximum amount of data per-partition the server will return.
`ConsumerConfigBuilder`	`withMaxPollInterval(Duration maxPollInterval)` The maximum delay between invocations of poll() when using consumer group management.
`ConsumerConfigBuilder`	`withMaxPollRecords(int maxPollRecords)` The maximum number of records returned in a single call to poll().
`ConsumerConfigBuilder`	`withPartitionAssignmentStrategy(Class<? extends org.apache.kafka.clients.consumer.internals.PartitionAssignor> partitionAssignmentStrategy)` The class of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used.
`ConsumerConfigBuilder`	`withSessionTimeout(Duration sessionTimeout)` The timeout used to detect consumer failures when using Kafka's group management facility.
`ConsumerConfigBuilder`	`withValueDeserializer(org.apache.kafka.common.serialization.Deserializer<?> valueDeserializer)` Deserializer class for value that implements the `org.apache.kafka.common.serialization.Deserializer` interface.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static ConsumerConfigBuilder create()
```
  - withGroupId
```
public ConsumerConfigBuilder withGroupId(String groupId)
```
    A unique string that identifies the consumer group this consumer belongs to. This property is required if the consumer uses either the group management functionality by using subscribe(topic) or the Kafka-based offset management strategy.
  - withGroupInstanceId
```
public ConsumerConfigBuilder withGroupInstanceId(String groupInstanceId)
```
    A unique identifier of the consumer instance provided by end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g. process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior.
  - withMaxPollRecords
```
public ConsumerConfigBuilder withMaxPollRecords(int maxPollRecords)
```
    The maximum number of records returned in a single call to poll().
  - withMaxPollInterval
```
public ConsumerConfigBuilder withMaxPollInterval(Duration maxPollInterval)
```
    The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member.
  - withSessionTimeout
```
public ConsumerConfigBuilder withSessionTimeout(Duration sessionTimeout)
```
    The timeout used to detect consumer failures when using Kafka's group management facility. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by group.min.session.timeout.ms and group.max.session.timeout.ms.
  - withHeartbeatInterval
```
public ConsumerConfigBuilder withHeartbeatInterval(Duration heartbeatInterval)
```
    The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances.
  - withEnableAutoCommit
```
public ConsumerConfigBuilder withEnableAutoCommit(boolean enableAutoCommit)
```
    If true the consumer's offset will be periodically committed in the background.
  - withAutoCommitInterval
```
public ConsumerConfigBuilder withAutoCommitInterval(Duration autoCommitInterval)
```
    The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true.
  - withPartitionAssignmentStrategy
```
public ConsumerConfigBuilder withPartitionAssignmentStrategy(Class<? extends org.apache.kafka.clients.consumer.internals.PartitionAssignor> partitionAssignmentStrategy)
```
    The class of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used.
  - withAutoOffsetReset
```
public ConsumerConfigBuilder withAutoOffsetReset(org.apache.kafka.clients.consumer.OffsetResetStrategy autoOffsetReset)
```
    What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted):
    - earliest: automatically reset the offset to the earliest offset
    - latest: automatically reset the offset to the latest offset
    - none: throw exception to the consumer if no previous offset is found for the consumer's group
    - anything else: throw exception to the consumer.
  - withFetchMinBytes
```
public ConsumerConfigBuilder withFetchMinBytes(int fetchMinBytes)
```
    The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request. The default setting of 1 byte means that fetch requests are answered as soon as a single byte of data is available or the fetch request times out waiting for data to arrive. Setting this to something greater than 1 will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency.
  - withFetchMaxBytes
```
public ConsumerConfigBuilder withFetchMaxBytes(int fetchMaxBytes)
```
    The maximum amount of data the server should return for a fetch request. Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel.
  - withFetchMaxWait
```
public ConsumerConfigBuilder withFetchMaxWait(Duration fetchMaxWait)
```
    The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes.
  - withMaxPartitionFetchBytes
```
public ConsumerConfigBuilder withMaxPartitionFetchBytes(int maxPartitionFetchBytes)
```
    The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). See FETCH_MAX_BYTES_CONFIG for limiting the consumer request size.
  - withCheckCRCs
```
public ConsumerConfigBuilder withCheckCRCs(boolean checkCRCs)
```
    Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance.
  - withKeyDeserializer
```
public ConsumerConfigBuilder withKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<?> keyDeserializer)
```
    Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface.
  - withValueDeserializer
```
public ConsumerConfigBuilder withValueDeserializer(org.apache.kafka.common.serialization.Deserializer<?> valueDeserializer)
```
    Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface.
  - withDefaultApiTimeout
```
public ConsumerConfigBuilder withDefaultApiTimeout(Duration defaultApiTimeout)
```
    Specifies the timeout for consumer APIs that could block. This configuration is used as the default timeout for all consumer operations that do not explicitly accept a timeout parameter.
  - withInterceptorClasses
```
@SafeVarargs
public final ConsumerConfigBuilder withInterceptorClasses(Class<? extends org.apache.kafka.clients.consumer.ConsumerInterceptor>... interceptorClasses)
```
    A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.consumer.ConsumerInterceptor interface allows you to intercept (and possibly mutate) records received by the consumer. By default, there are no interceptors.
  - withExcludeInternalTopics
```
public ConsumerConfigBuilder withExcludeInternalTopics(boolean excludeInternalTopics)
```
    Whether internal topics matching a subscribed pattern should be excluded from the subscription. It is always possible to explicitly subscribe to an internal topic.
  - withIsolationLevel
```
public ConsumerConfigBuilder withIsolationLevel(org.apache.kafka.common.requests.IsolationLevel isolationLevel)
```
    Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted' (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode.
    
    Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions.
    Further, when in read_committed the seekToEnd method will return the LSO
  - withAllowAutoCreateTopics
```
public ConsumerConfigBuilder withAllowAutoCreateTopics(boolean allowAutoCreateTopics)
```
    Allow automatic topic creation on the broker when subscribing to or assigning a topic. A topic being subscribed to will be automatically created only if the broker allows for it using `auto.create.topics.enable` broker configuration. This configuration must be set to `false` when using brokers older than 0.11.0

Class ConsumerConfigBuilder

Field Summary

Fields inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder

Method Summary

Methods inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder

Methods inherited from class java.lang.Object

Method Detail

create

withGroupId

withGroupInstanceId

withMaxPollRecords

withMaxPollInterval

withSessionTimeout

withHeartbeatInterval

withEnableAutoCommit

withAutoCommitInterval

withPartitionAssignmentStrategy

withAutoOffsetReset

withFetchMinBytes

withFetchMaxBytes

withFetchMaxWait

withMaxPartitionFetchBytes

withCheckCRCs

withKeyDeserializer

withValueDeserializer

withDefaultApiTimeout

withInterceptorClasses

withExcludeInternalTopics

withIsolationLevel

withAllowAutoCreateTopics