Class KafkaConsumerConfig

Extends the Confluent.Kafka.ConsumerConfig adding the Silverback specific settings.

Inheritance
System.Object
ConfluentClientConfigProxy
ConfluentConsumerConfigProxy
KafkaConsumerConfig
Implements
System.IEquatable<KafkaConsumerConfig>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Silverback.Messaging.Configuration.Kafka
Assembly: Silverback.Integration.Kafka.dll
Syntax
public sealed class KafkaConsumerConfig : ConfluentConsumerConfigProxy, IValidatableEndpointSettings, IEquatable<KafkaConsumerConfig>

Constructors

| Improve this doc View source

KafkaConsumerConfig(KafkaClientConfig)

Initializes a new instance of the KafkaConsumerConfig class.

Declaration
public KafkaConsumerConfig(KafkaClientConfig clientConfig = null)
Parameters
Type Name Description
KafkaClientConfig clientConfig

The KafkaClientConfig to be used to initialize the KafkaConsumerConfig.

Properties

| Improve this doc View source

CommitOffsetEach

Defines the number of message to be processed before committing the offset to the server. The most reliable level is 1 but it reduces throughput.

Declaration
public int CommitOffsetEach { get; set; }
Property Value
Type Description
System.Int32
| Improve this doc View source

EnableAutoRecovery

Specifies whether the consumer has to be automatically recycled when a Confluent.Kafka.KafkaException is thrown while polling/consuming or an issues is detected (e.g. a poll timeout is reported). The default is true.

Declaration
public bool EnableAutoRecovery { get; set; }
Property Value
Type Description
System.Boolean
| Improve this doc View source

GroupId

Client group id string. All clients sharing the same group.id belong to the same group.

default: ''
importance: high.

Declaration
public override string GroupId { get; set; }
Property Value
Type Description
System.String
Overrides
| Improve this doc View source

IsAutoCommitEnabled

Gets a value indicating whether autocommit is enabled according to the explicit configuration and Kafka defaults.

Declaration
public bool IsAutoCommitEnabled { get; }
Property Value
Type Description
System.Boolean
| Improve this doc View source

IsGroupIdSet

Returns a boolean indicating whether group.id is set.

Declaration
public bool IsGroupIdSet { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this doc View source

Equals(KafkaConsumerConfig)

Declaration
public bool Equals(KafkaConsumerConfig other)
Parameters
Type Name Description
KafkaConsumerConfig other
Returns
Type Description
System.Boolean
| Improve this doc View source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this doc View source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this doc View source

Validate()

Declaration
public override void Validate()
Overrides

Implements

System.IEquatable<T>