AspireKafkaConsumerExtensions Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Confluent.Kafka
5. /AspireKafkaConsumerExtensions
6. /Methods

ClassMethods12 members

Extension methods for connecting to a Kafka broker.

AddKafkaConsumer(IHostApplicationBuilder, string)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs#L27

Parameters

builderIHostApplicationBuilder

connectionNamestring

AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaConsumerSettings>? configureSettings)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs#L31

Parameters

builderIHostApplicationBuilder

connectionNamestring

configureSettingsAction<KafkaConsumerSettings>

AddKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

connectionNamestring

configureBuilderAction<ConsumerBuilder<TKey, TValue>>

AddKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

connectionNamestring

configureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>

AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaConsumerSettings>? configureSettings,
        Action<ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

connectionNamestring

configureSettingsAction<KafkaConsumerSettings>

configureBuilderAction<ConsumerBuilder<TKey, TValue>>

AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extension

Registers Kafka.IConsumer`2 as a singleton in the services provided by the builder.

public static class AspireKafkaConsumerExtensions
{
    public static void AddKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaConsumerSettings>? configureSettings,
        Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.

configureSettingsAction<KafkaConsumerSettings>An optional method for customizing the KafkaConsumerSettings.

configureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>An optional method used for customizing the Kafka.ConsumerBuilder`2.

Remarks

Reads the configuration from "Aspire:Kafka:Consumer" section.

AddKeyedKafkaConsumer(IHostApplicationBuilder, string)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs#L59-L62

Parameters

builderIHostApplicationBuilder

namestring

AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaConsumerSettings>? configureSettings)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs#L67-L70

Parameters

builderIHostApplicationBuilder

namestring

configureSettingsAction<KafkaConsumerSettings>

AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

namestring

configureBuilderAction<ConsumerBuilder<TKey, TValue>>

AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

namestring

configureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>

AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)extension

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaConsumerSettings>? configureSettings,
        Action<ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilder

namestring

configureSettingsAction<KafkaConsumerSettings>

configureBuilderAction<ConsumerBuilder<TKey, TValue>>

AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extension

Registers Kafka.IConsumer`2 as a keyed singleton for the given name in the services provided by the builder.

public static class AspireKafkaConsumerExtensions
{
    public static void AddKeyedKafkaConsumer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaConsumerSettings>? configureSettings,
        Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}

AspireKafkaConsumerExtensions.cs

Parameters

builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.

namestringThe name of the component, which is used as the ServiceDescriptor.ServiceKey of the service and also to retrieve the connection string from the ConnectionStrings configuration section.

configureSettingsAction<KafkaConsumerSettings>An optional method for customizing the KafkaConsumerSettings.

configureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>An optional method used for customizing the Kafka.ConsumerBuilder`2.

Remarks

Reads the configuration from "Aspire:Kafka:Consumer:{name}" section.