AspireKafkaConsumerExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Confluent.Kafka / AspireKafkaConsumerExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Confluent.Kafka AspireKafkaConsumerExtensions Methods

Class Methods 12 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

builder IHostApplicationBuilder

connectionName string

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

builder IHostApplicationBuilder

connectionName string

configureSettings Action<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

builder IHostApplicationBuilder

connectionName string

configureBuilder Action<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

builder IHostApplicationBuilder

connectionName string

configureBuilder Action<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

builder IHostApplicationBuilder

connectionName string

configureSettings Action<KafkaConsumerSettings>

configureBuilder Action<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

builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.

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

configureSettings Action<KafkaConsumerSettings> An optional method for customizing the KafkaConsumerSettings.

configureBuilder Action<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

builder IHostApplicationBuilder

name string

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

builder IHostApplicationBuilder

name string

configureSettings Action<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

builder IHostApplicationBuilder

name string

configureBuilder Action<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

builder IHostApplicationBuilder

name string

configureBuilder Action<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

builder IHostApplicationBuilder

name string

configureSettings Action<KafkaConsumerSettings>

configureBuilder Action<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

builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.

name string The 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.

configureSettings Action<KafkaConsumerSettings> An optional method for customizing the KafkaConsumerSettings.

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

Remarks

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