Class ClientOpenSearchElasticsearchBackendClientSettings

java.lang.Object

org.hibernate.search.backend.elasticsearch.client.opensearch.rest.cfg.ClientOpenSearchElasticsearchBackendClientSettings

@Incubating
public final class ClientOpenSearchElasticsearchBackendClientSettings
extends Object

Specific configuration properties for the Elasticsearch backend's rest client based on the Elasticsearch's low-level rest client.

Constants in this class are to be appended to a prefix to form a property key; see BackendSettings for details.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClientOpenSearchElasticsearchBackendClientSettings.Defaults	Default values for the different settings if no values are given.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_CONFIGURER	A ElasticsearchHttpClientConfigurer that defines custom HTTP client configuration.
static final String	CONNECTION_TIMEOUT	The timeout when establishing a connection to an Elasticsearch server.
static final String	DISCOVERY_ENABLED	Whether automatic discovery of nodes in the Elasticsearch cluster is enabled.
static final String	DISCOVERY_REFRESH_INTERVAL	The time interval between two executions of the automatic discovery, if enabled.
static final String	MAX_CONNECTIONS	The maximum number of simultaneous connections to the Elasticsearch cluster, all hosts taken together.
static final String	MAX_CONNECTIONS_PER_ROUTE	The maximum number of simultaneous connections to each host of the Elasticsearch cluster.
static final String	MAX_KEEP_ALIVE	How long connections to the Elasticsearch cluster can be kept idle.
static final String	READ_TIMEOUT	The timeout when reading responses from an Elasticsearch server.
static final String	REQUEST_TIMEOUT	The timeout when executing a request to an Elasticsearch server.

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REQUEST_TIMEOUT

public static final String REQUEST_TIMEOUT

The timeout when executing a request to an Elasticsearch server.

This includes the time needed to establish a connection, send the request and read the response.

Expects a positive Integer value in milliseconds, such as 60000, or a String that can be parsed into such Integer value.

Defaults to no request timeout.

See Also:

• Constant Field Values

READ_TIMEOUT

public static final String READ_TIMEOUT

The timeout when reading responses from an Elasticsearch server.

Expects a positive Integer value in milliseconds, such as 60000, or a String that can be parsed into such Integer value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.READ_TIMEOUT.

See Also:

• Constant Field Values

CONNECTION_TIMEOUT

public static final String CONNECTION_TIMEOUT

The timeout when establishing a connection to an Elasticsearch server.

Expects a positive Integer value in milliseconds, such as 3000, or a String that can be parsed into such Integer value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.CONNECTION_TIMEOUT.

See Also:

• Constant Field Values

MAX_CONNECTIONS

public static final String MAX_CONNECTIONS

The maximum number of simultaneous connections to the Elasticsearch cluster, all hosts taken together.

Expects a positive Integer value, such as 40, or a String that can be parsed into such Integer value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.MAX_CONNECTIONS.

See Also:

• Constant Field Values

MAX_CONNECTIONS_PER_ROUTE

public static final String MAX_CONNECTIONS_PER_ROUTE

The maximum number of simultaneous connections to each host of the Elasticsearch cluster.

Expects a positive Integer value, such as 20, or a String that can be parsed into such Integer value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.MAX_CONNECTIONS_PER_ROUTE.

See Also:

• Constant Field Values

DISCOVERY_ENABLED

public static final String DISCOVERY_ENABLED

Whether automatic discovery of nodes in the Elasticsearch cluster is enabled.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.DISCOVERY_ENABLED.

See Also:

• Constant Field Values

DISCOVERY_REFRESH_INTERVAL

public static final String DISCOVERY_REFRESH_INTERVAL

The time interval between two executions of the automatic discovery, if enabled.

Expects a positive Integer value in seconds, such as 2, or a String that can be parsed into such Integer value.

Defaults to ClientOpenSearchElasticsearchBackendClientSettings.Defaults.DISCOVERY_REFRESH_INTERVAL.

See Also:

• Constant Field Values

MAX_KEEP_ALIVE

public static final String MAX_KEEP_ALIVE

How long connections to the Elasticsearch cluster can be kept idle.

Expects a positive Long value of milliseconds, such as 60000, or a String that can be parsed into such Integer value.

If the response from an Elasticsearch cluster contains a Keep-Alive header, then the effective max idle time will be whichever is lower: the duration from the Keep-Alive header or the value of this property (if set).

If this property is not set, only the Keep-Alive header is considered, and if it's absent, idle connections will be kept forever.

See Also:

• Constant Field Values

CLIENT_CONFIGURER

public static final String CLIENT_CONFIGURER

A ElasticsearchHttpClientConfigurer that defines custom HTTP client configuration.

It can be used for example to tune the SSL context to accept self-signed certificates. It allows overriding other HTTP client settings, such as ElasticsearchBackendSettings.USERNAME or MAX_CONNECTIONS_PER_ROUTE.

Expects a reference to a bean of type ElasticsearchHttpClientConfigurer.

Defaults to no value.

See Also:

• Constant Field Values