AspireElasticClientsElasticsearchExtensions Methods
ClassMethods2 members
Extension methods for connecting Elasticsearch with Elastic.Clients.Elasticsearch client.
AddElasticsearchClient(IHostApplicationBuilder, string, Action<ElasticClientsElasticsearchSettings>, Action<ElasticsearchClientSettings>)Section titled AddElasticsearchClient(IHostApplicationBuilder, string, Action<ElasticClientsElasticsearchSettings>, Action<ElasticsearchClientSettings>)extension Registers
Elasticsearch.ElasticsearchClient instance for connecting to Elasticsearch with Elastic.Clients.Elasticsearch client. public static class AspireElasticClientsElasticsearchExtensions{ public static void AddElasticsearchClient( this IHostApplicationBuilder builder, string connectionName, Action<ElasticClientsElasticsearchSettings>? configureSettings = null, Action<ElasticsearchClientSettings>? configureClientSettings = null) { // ... }}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<ElasticClientsElasticsearchSettings>optionalAn optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.configureClientSettingsAction<ElasticsearchClientSettings>optionalAn optional delegate that can be used for customizing ElasticsearchClientSettings.Exceptions
InvalidOperationExceptionIf required ConnectionString is not provided in configuration sectionAddKeyedElasticsearchClient(IHostApplicationBuilder, string, Action<ElasticClientsElasticsearchSettings>, Action<ElasticsearchClientSettings>)Section titled AddKeyedElasticsearchClient(IHostApplicationBuilder, string, Action<ElasticClientsElasticsearchSettings>, Action<ElasticsearchClientSettings>)extension Registers
Elasticsearch.ElasticsearchClient instance for connecting to Elasticsearch with Elastic.Clients.Elasticsearch client. public static class AspireElasticClientsElasticsearchExtensions{ public static void AddKeyedElasticsearchClient( this IHostApplicationBuilder builder, string name, Action<ElasticClientsElasticsearchSettings>? configureSettings = null, Action<ElasticsearchClientSettings>? configureClientSettings = null) { // ... }}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<ElasticClientsElasticsearchSettings>optionalAn optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.configureClientSettingsAction<ElasticsearchClientSettings>optionalAn optional delegate that can be used for customizing ElasticsearchClientSettings.Exceptions
InvalidOperationExceptionIf required ConnectionString is not provided in configuration section