Table of Contents

Class ElasticsearchConfigurationOptions

Namespace
Excalibur.Data.ElasticSearch
Assembly
Excalibur.Data.ElasticSearch.dll

Configures the settings for Elasticsearch client connections and operations.

public sealed class ElasticsearchConfigurationOptions
Inheritance
ElasticsearchConfigurationOptions
Inherited Members

Remarks

This class provides comprehensive configuration options for connecting to Elasticsearch clusters, including endpoint selection, connection pooling, resilience policies, monitoring, performance optimizations, and projection management. Connection-level settings (authentication, timeouts, SSL/TLS) are configured via the Connection sub-options.

Properties

CloudId

Gets the Elastic Cloud ID for Elastic Cloud deployments.

public string? CloudId { get; init; }

Property Value

string

A string representing the Cloud ID for Elastic Cloud connections, or null if not using Elastic Cloud.

Connection

Gets the configuration for connection-level settings including authentication, timeouts, SSL/TLS, and pool tuning.

public ElasticsearchConnectionOptions Connection { get; init; }

Property Value

ElasticsearchConnectionOptions

The connection settings for the Elasticsearch client.

ConnectionPoolType

Gets the connection pool type for multi-node clusters.

public ConnectionPoolType ConnectionPoolType { get; init; }

Property Value

ConnectionPoolType

The type of connection pool to use. Defaults to Static.

EnableSniffing

Gets a value indicating whether to enable connection sniffing for dynamic node discovery.

public bool EnableSniffing { get; init; }

Property Value

bool

A bool indicating whether to enable sniffing. Only applicable when using Sniffing. Defaults to false .

Monitoring

Gets the configuration for monitoring and diagnostics.

public ElasticsearchMonitoringOptions Monitoring { get; init; }

Property Value

ElasticsearchMonitoringOptions

The monitoring settings for metrics, logging, performance diagnostics, and tracing.

Projections

Gets the configuration for projection management.

public ElasticSearchProjectionManagementOptions Projections { get; init; }

Property Value

ElasticSearchProjectionManagementOptions

The projection settings for error handling, rebuilding, and consistency tracking.

Resilience

Gets the configuration for resilience policies.

public ElasticsearchResilienceOptions Resilience { get; init; }

Property Value

ElasticsearchResilienceOptions

The resilience settings for retry and circuit breaker handling.

Url

Gets the URL of the Elasticsearch cluster.

public Uri? Url { get; init; }

Property Value

Uri

A Uri representing the base URL of the Elasticsearch cluster. This property is required when using single-node configuration.

Urls

Gets the collection of URLs for multi-node cluster configuration.

public IEnumerable<Uri>? Urls { get; init; }

Property Value

IEnumerable<Uri>

A collection of Uri representing the URLs of the Elasticsearch cluster nodes. Used for cluster configuration with connection pooling.