Record - kafka : ConsumerConfig

Configuration related to consumer endpoint.

Fields

  • bootstrapServers string? (default ())
  • List of remote server endpoints of kafka brokers.

  • groupId string? (default ())
  • Unique string that identifies the consumer.

  • offsetReset string? (default ())
  • Offset reset strategy if no initial offset.

  • partitionAssignmentStrategy string? (default ())
  • Strategy class for handling the partition assignment among consumers.

  • metricsRecordingLevel string? (default ())
  • Metrics recording level.

  • metricsReporterClasses string? (default ())
  • Metrics reporter classes.

  • clientId string? (default ())
  • Identifier to be used for server side logging.

  • interceptorClasses string? (default ())
  • Interceptor classes to be used before sending records.

  • isolationLevel string? (default ())
  • Transactional message reading method. Use "read_committed" to read the committed messages only in transactional mode when poll() is called. Use "read_uncommitted" to read all the messages, even the aborted ones.

  • topics string[]? (default ())
  • Topics to be subscribed by the consumer.

  • properties string[]? (default ())
  • Additional properties if required.

  • sessionTimeoutInMillis int (default -1)
  • Timeout used to detect consumer failures when heartbeat threshold is reached.

  • heartBeatIntervalInMillis int (default -1)
  • Expected time between heartbeats.

  • metadataMaxAgeInMillis int (default -1)
  • Maximum time to force a refresh of metadata.

  • autoCommitIntervalInMillis int (default -1)
  • Auto committing interval for commit offset, when auto-commit is enabled.

  • maxPartitionFetchBytes int (default -1)
  • The maximum amount of data per-partition the server returns.

  • sendBuffer int (default -1)
  • Size of the TCP send buffer (SO_SNDBUF).

  • receiveBuffer int (default -1)
  • Size of the TCP receive buffer (SO_RCVBUF).

  • fetchMinBytes int (default -1)
  • Minimum amount of data the server should return for a fetch request.

  • fetchMaxBytes int (default -1)
  • Maximum amount of data the server should return for a fetch request.

  • fetchMaxWaitTimeInMillis int (default -1)
  • Maximum amount of time the server will block before answering the fetch request.

  • reconnectBackoffTimeMaxInMillis int (default -1)
  • Maximum amount of time in milliseconds to wait when reconnecting.

  • retryBackoffInMillis int (default -1)
  • Time to wait before attempting to retry a failed request.

  • metricsSampleWindowInMillis int (default -1)
  • Window of time a metrics sample is computed over.

  • metricsNumSamples int (default -1)
  • Number of samples maintained to compute metrics.

  • requestTimeoutInMillis int (default -1)
  • Wait time for response of a request.

  • connectionMaxIdleTimeInMillis int (default -1)
  • Close idle connections after the number of milliseconds.

  • maxPollRecords int (default -1)
  • Maximum number of records returned in a single call to poll.

  • maxPollInterval int (default -1)
  • Maximum delay between invocations of poll.

  • reconnectBackoffTimeInMillis int (default -1)
  • Time to wait before attempting to reconnect.

  • pollingTimeoutInMillis int (default -1)
  • Timeout interval for polling.

  • pollingIntervalInMillis int (default -1)
  • Polling interval for the consumer.

  • concurrentConsumers int (default -1)
  • Number of concurrent consumers.

  • defaultApiTimeoutInMillis int (default 30000)
  • 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.

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