Table of Contents

Class ElasticsearchConnectionOptions

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

Configures connection-level settings for Elasticsearch client connections, including authentication, timeouts, SSL/TLS, and connection pool tuning.

public sealed class ElasticsearchConnectionOptions
Inheritance
ElasticsearchConnectionOptions
Inherited Members

Properties

ApiKey

Gets the API key for Elasticsearch authentication.

public string? ApiKey { get; init; }

Property Value

string

A string representing the API key, or null if API key authentication is not used.

Base64ApiKey

Gets the Base64-encoded API key for Elasticsearch authentication.

public string? Base64ApiKey { get; init; }

Property Value

string

A string representing the Base64-encoded API key, or null if Base64 API key authentication is not used.

CertificateFingerprint

Gets the certificate fingerprint for SSL/TLS verification.

public string? CertificateFingerprint { get; init; }

Property Value

string

A string representing the certificate fingerprint for secure connections, or null if not required.

DisableCertificateValidation

Gets a value indicating whether to disable SSL certificate validation.

public bool DisableCertificateValidation { get; init; }

Property Value

bool

A bool indicating whether to disable SSL certificate validation. Defaults to false .

MaximumConnectionsPerNode

Gets the maximum number of connections per node.

public int MaximumConnectionsPerNode { get; init; }

Property Value

int

An int representing the maximum connections per node. Defaults to 80.

Password

Gets the password for basic authentication.

public string? Password { get; init; }

Property Value

string

A string representing the password, or null if basic authentication is not used.

PingTimeout

Gets the ping timeout for node health checks.

public TimeSpan PingTimeout { get; init; }

Property Value

TimeSpan

A TimeSpan representing the ping timeout. Defaults to 5 seconds.

RequestTimeout

Gets the request timeout for Elasticsearch operations.

public TimeSpan RequestTimeout { get; init; }

Property Value

TimeSpan

A TimeSpan representing the request timeout. Defaults to 30 seconds.

SniffingInterval

Gets the interval for sniffing node information.

public TimeSpan SniffingInterval { get; init; }

Property Value

TimeSpan

A TimeSpan representing the sniffing interval. Defaults to 1 hour.

Username

Gets the username for basic authentication.

public string? Username { get; init; }

Property Value

string

A string representing the username, or null if basic authentication is not used.