AspireKafkaConsumerExtensions Methods
ClassMethods12 members
Extension methods for connecting to a Kafka broker.
AddKafkaConsumer(IHostApplicationBuilder, string)Section titled AddKafkaConsumer(IHostApplicationBuilder, string)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string connectionName) { // ... }}Parameters
builderIHostApplicationBuilderconnectionNamestringAddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)Section titled AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string connectionName, Action<KafkaConsumerSettings>? configureSettings) { // ... }}Parameters
builderIHostApplicationBuilderconnectionNamestringconfigureSettingsAction<KafkaConsumerSettings>AddKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)Section titled AddKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string connectionName, Action<ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuilderconnectionNamestringconfigureBuilderAction<ConsumerBuilder<TKey, TValue>>AddKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)Section titled AddKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string connectionName, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuilderconnectionNamestringconfigureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)Section titled AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string connectionName, Action<KafkaConsumerSettings>? configureSettings, Action<ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuilderconnectionNamestringconfigureSettingsAction<KafkaConsumerSettings>configureBuilderAction<ConsumerBuilder<TKey, TValue>>AddKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)Section titled 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) { // ... }}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)Section titled AddKeyedKafkaConsumer(IHostApplicationBuilder, string)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKeyedKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string name) { // ... }}Parameters
builderIHostApplicationBuildernamestringAddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)Section titled AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKeyedKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string name, Action<KafkaConsumerSettings>? configureSettings) { // ... }}Parameters
builderIHostApplicationBuildernamestringconfigureSettingsAction<KafkaConsumerSettings>AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)Section titled AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKeyedKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string name, Action<ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuildernamestringconfigureBuilderAction<ConsumerBuilder<TKey, TValue>>AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)Section titled AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKeyedKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string name, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuildernamestringconfigureBuilderAction<IServiceProvider, ConsumerBuilder<TKey, TValue>>AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)Section titled AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<ConsumerBuilder<TKey, TValue>>)extensionpublic static class AspireKafkaConsumerExtensions{ public static void AddKeyedKafkaConsumer<TKey, TValue>( this IHostApplicationBuilder builder, string name, Action<KafkaConsumerSettings>? configureSettings, Action<ConsumerBuilder<TKey, TValue>>? configureBuilder) { // ... }}Parameters
builderIHostApplicationBuildernamestringconfigureSettingsAction<KafkaConsumerSettings>configureBuilderAction<ConsumerBuilder<TKey, TValue>>AddKeyedKafkaConsumer(IHostApplicationBuilder, string, Action<KafkaConsumerSettings>, Action<IServiceProvider, ConsumerBuilder<TKey, TValue>>)Section titled 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) { // ... }}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.