Record -
kafka
: ConsumerConfiguration
Configurations related to consumer endpoint.
Fields
- bootstrapServers string
-
List of remote server endpoints of kafka brokers
- groupId string
-
Unique string that identifies the consumer
- topics string[]
-
Topics to be subscribed by the consumer
- offsetReset string
-
Offset reset strategy if no initial offset
- partitionAssignmentStrategy string
-
Strategy class for handling the partition assignment among consumers
- metricsRecordingLevel string
-
Metrics recording level
- metricsReporterClasses string
-
Metrics reporter classes
- clientId string
-
Identifier to be used for server side logging
- interceptorClasses string
-
Interceptor classes to be used before sending records
- isolationLevel IsolationLevel
-
Transactional message reading method
- keyDeserializerType DeserializerType (default DES_BYTE_ARRAY)
-
Deserializer used for the Kafka record key. This should be a
kafka:DeserializerType
- valueDeserializerType DeserializerType (default DES_BYTE_ARRAY)
-
Deserializer used for the Kafka record value. This should be a
kafka:DeserializerType
- keyDeserializer Deserializer
-
Custom deserializer object to deserialize kafka keys. This should be implement the
kafka:Deserializer
object
- valueDeserializer Deserializer
-
Custom deserializer object to deserialize kafka values. This should implement the
kafka:Deserializer
object
- schemaRegistryUrl string
-
Avro schema registry url. Use this field to specify schema registry url, if Avro serializer is used
- properties map
-
Additional properties for the property fields not provided by Ballerina Kafka module. Use this with caution since this can override any of the fields. It is not recomendded to use this field except in an extreme situation
- sessionTimeoutInMillis int
-
Timeout used to detect consumer failures when heartbeat threshold is reached
- heartBeatIntervalInMillis int
-
Expected time between heartbeats
- metadataMaxAgeInMillis int
-
Maximum time to force a refresh of metadata
- autoCommitIntervalInMillis int
-
Auto committing interval for commit offset, when auto-commit is enabled
- maxPartitionFetchBytes int
-
The maximum amount of data per-partition the server returns
- sendBuffer int
-
Size of the TCP send buffer (SO_SNDBUF)
- receiveBuffer int
-
Size of the TCP receive buffer (SO_RCVBUF)
- fetchMinBytes int
-
Minimum amount of data the server should return for a fetch request
- fetchMaxBytes int
-
Maximum amount of data the server should return for a fetch request
- fetchMaxWaitTimeInMillis int
-
Maximum amount of time the server will block before answering the fetch request
- reconnectBackoffTimeMaxInMillis int
-
Maximum amount of time in milliseconds to wait when reconnecting
- retryBackoffInMillis int
-
Time to wait before attempting to retry a failed request
- metricsSampleWindowInMillis int
-
Window of time a metrics sample is computed over
- metricsNumSamples int
-
Number of samples maintained to compute metrics
- requestTimeoutInMillis int
-
Wait time for response of a request
- connectionMaxIdleTimeInMillis int
-
Close idle connections after the number of milliseconds
- maxPollRecords int
-
Maximum number of records returned in a single call to poll
- maxPollInterval int
-
Maximum delay between invocations of poll
- reconnectBackoffTimeInMillis int
-
Time to wait before attempting to reconnect
- pollingTimeoutInMillis int
-
Timeout interval for polling
- pollingIntervalInMillis int
-
Polling interval for the consumer
- concurrentConsumers int
-
Number of concurrent consumers
- defaultApiTimeoutInMillis int
-
Default API timeout value for APIs with duration
- autoCommit boolean (default true)
-
Enables auto committing offsets
- checkCRCS boolean (default true)
-
Check the CRC32 of the records consumed. This ensures that no on-the-wire or on-disk corruption to the messages occurred. This may add some overhead, and might needed set to
false
if extreme performance is required
- excludeInternalTopics boolean (default true)
-
Whether records from internal topics should be exposed to the consumer
- decoupleProcessing boolean (default false)
-
Decouples processing
- secureSocket SecureSocket
-
Configurations related to SSL/TLS encryption
- authenticationConfiguration AuthenticationConfiguration
-
Authentication-related configurations for the Kafka consumer