ConsumerConfig

Namespace: Kafunk

Kafka consumer configuration.

Record Fields

Record Field	Description
`assignmentStrategies` Signature: (AssignmentStrategyName * AssignmentStrategy) []	The consumer group assignment strategies to use. The group coordinator ensures that all members support the same strategy. When multiple stratgies are supported by all members, the first one in the list is selected.
`autoOffsetReset` Signature: AutoOffsetReset	The action to take when the consumer doesn't have offsets at the group coordinator, or if out of range offsets are requested.
`checkCrc` Signature: bool	Specifies whether CRC of incoming messages is verified.
`endOfTopicPollPolicy` Signature: RetryPolicy	The poll policy to employ when the end of the topic is reached.
`fetchBufferSize` Signature: int	The size of the per-partition fetch buffer in terms of message set count. When at capacity, fetching stops until the buffer is drained.
`fetchMaxBytes` Signature: MaxBytes	The maximum bytes to return as part of a partition for a fetch request.
`fetchMaxWaitMs` Signature: MaxWaitTime	The maximum time to wait for a fetch request to return sufficient data.
`fetchMinBytes` Signature: MinBytes	The minimum bytes to buffer server side for a fetch request. 0 to return immediately.
`groupId` Signature: GroupId	The consumer group id shared by consumers in the group.
`heartbeatFrequency` Signature: int32	The number of times to send heartbeats within a session timeout period.
`offsetRetentionTime` Signature: RetentionTime	Offset retention time.
`rebalanceTimeout` Signature: RebalanceTimeout	The time during which a consumer must rejoin a group after a rebalance. If the consumer doesn't rejoin within this time, it will be ejected. Supported in v0.10.1.
`sessionTimeout` Signature: SessionTimeout	The session timeout period, in milliseconds, such that if no heartbeats are received within the period, a consumer is ejected from the consumer group.
`topic` Signature: TopicName	The topic to consume.

Static members

Static member	Description
`create(...)` Signature: (groupId:GroupId * topic:TopicName * fetchMaxBytes:MaxBytes option * sessionTimeout:SessionTimeout option * rebalanceTimeout:RebalanceTimeout option * heartbeatFrequency:int32 option * offsetRetentionTime:RetentionTime option * fetchMinBytes:MinBytes option * fetchMaxWaitMs:MaxWaitTime option * endOfTopicPollPolicy:RetryPolicy option * autoOffsetReset:AutoOffsetReset option * fetchBufferSize:int option * assignmentStrategies:(AssignmentStrategyName * AssignmentStrategy) [] option * checkCrc:bool option) -> ConsumerConfig	Creates a consumer configuration.
`DefaultAssignmentStrategies` Signature: (string * AssignmentStrategy) []	Gets the default fetch buffer size = [\| "range", ConsumerGroup.AssignmentStratgies.Range \|]. CompiledName: `get_DefaultAssignmentStrategies`
`DefaultAutoOffsetReset` Signature: AutoOffsetReset	Gets the default offset reset action = AutoOffsetResetAction.StartFromPreviousCommittedOffsets. CompiledName: `get_DefaultAutoOffsetReset`
`DefaultCheckCrc` Signature: bool	Gets the default value for check crc = true. CompiledName: `get_DefaultCheckCrc`
`DefaultEndOfTopicPollPolicy` Signature: RetryPolicy	Gets the default end of topic poll policy = RetryPolicy.constantMs 10000. CompiledName: `get_DefaultEndOfTopicPollPolicy`
`DefaultFetchBufferSize` Signature: int	Gets the default fetch buffer size = 1. CompiledName: `get_DefaultFetchBufferSize`
`DefaultFetchMaxBytes` Signature: int	Gets the default fetch max bytes = 1048576. CompiledName: `get_DefaultFetchMaxBytes`
`DefaultFetchMaxWait` Signature: int	Gets the default fetch max wait = 500. CompiledName: `get_DefaultFetchMaxWait`
`DefaultFetchMinBytes` Signature: int	Gets the default fetch min bytes = 1. CompiledName: `get_DefaultFetchMinBytes`
`DefaultHeartbeatFrequency` Signature: int	Gets the default heartbeat frequency = 3. CompiledName: `get_DefaultHeartbeatFrequency`
`DefaultOffsetRetentionTime` Signature: int64	Gets the default offset retention time = -1. CompiledName: `get_DefaultOffsetRetentionTime`
`DefaultRebalanceTimeout` Signature: int	Gets the default rebalance timeout = 10000. CompiledName: `get_DefaultRebalanceTimeout`
`DefaultSessionTimeout` Signature: int	Gets the default session timeout = 30000. CompiledName: `get_DefaultSessionTimeout`

Fork me on GitHub