> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.nimbleapps.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# KafkaOptions

> Specifies the options required to leverage Apache Kafka as the SimpleMessageBus backing queue.

## Definition

**Assembly:** CloudNimble.SimpleMessageBus.Core.dll

**Namespace:** CloudNimble.SimpleMessageBus.Core

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.SimpleMessageBus.Core.KafkaOptions
```

## Summary

Specifies the options required to leverage Apache Kafka as the SimpleMessageBus backing queue.

## Constructors

###  .ctor

Creates a new instance with default values from [KafkaConstants](https://easyaf.nimbleapps.cloud/simplemessagebus/api-reference/CloudNimble/SimpleMessageBus/Core/KafkaConstants.md).

#### Syntax

```csharp theme={"dark"}
public KafkaOptions()
```

###  .ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

###  AuthenticationMode

The SASL authentication mechanism when using SASL protocols.

#### Syntax

```csharp theme={"dark"}
public CloudNimble.SimpleMessageBus.Core.KafkaAuthenticationMode AuthenticationMode { get; set; }
```

#### Property Value

Type: `CloudNimble.SimpleMessageBus.Core.KafkaAuthenticationMode`

###  BrokerList

The Kafka broker list (e.g., "localhost:9092" or "broker1:9092,broker2:9092").

#### Syntax

```csharp theme={"dark"}
public string BrokerList { get; set; }
```

#### Property Value

Type: `string`

###  ConsumerGroup

The consumer group ID for message consumption.

#### Syntax

```csharp theme={"dark"}
public string ConsumerGroup { get; set; }
```

#### Property Value

Type: `string`

###  MaxBatchSize

Maximum number of messages to process in a batch. Default is 64.

#### Syntax

```csharp theme={"dark"}
public int MaxBatchSize { get; set; }
```

#### Property Value

Type: `int`

###  Password

SASL password for authentication.

#### Syntax

```csharp theme={"dark"}
public string Password { get; set; }
```

#### Property Value

Type: `string`

###  Protocol

The security protocol for broker communication.

#### Syntax

```csharp theme={"dark"}
public CloudNimble.SimpleMessageBus.Core.KafkaBrokerProtocol Protocol { get; set; }
```

#### Property Value

Type: `CloudNimble.SimpleMessageBus.Core.KafkaBrokerProtocol`

###  SslCaLocation

Path to CA certificate file for SSL/TLS verification.

#### Syntax

```csharp theme={"dark"}
public string SslCaLocation { get; set; }
```

#### Property Value

Type: `string`

###  TopicName

The name of the Kafka topic for messages.

#### Syntax

```csharp theme={"dark"}
public string TopicName { get; set; }
```

#### Property Value

Type: `string`

###  Username

SASL username for authentication.

#### Syntax

```csharp theme={"dark"}
public string Username { get; set; }
```

#### Property Value

Type: `string`

## Methods

###  Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

###  Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

###  GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

###  GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

###  MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

###  ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

###  ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.