Package io.quarkus.hibernate.search.backend.elasticsearch.common.runtime

Interface HibernateSearchBackendElasticsearchRuntimeConfig

public interface HibernateSearchBackendElasticsearchRuntimeConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.DiscoveryConfig
static enum	HibernateSearchBackendElasticsearchRuntimeConfig.ElasticsearchClientProtocol
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.IndexConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.IndexingConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.LayoutConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.QueryConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.QueryShardFailureConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.SchemaManagementConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.ThreadPoolConfig
static interface	HibernateSearchBackendElasticsearchRuntimeConfig.VersionCheckConfig

Method Summary

Modifier and Type	Method	Description
Duration	connectionTimeout()	The timeout when establishing a connection to an Elasticsearch server.
HibernateSearchBackendElasticsearchRuntimeConfig.DiscoveryConfig	discovery()	Configuration for the automatic discovery of new Elasticsearch nodes.
List<String>	hosts()	The list of hosts of the Elasticsearch servers.
HibernateSearchBackendElasticsearchRuntimeConfig.IndexConfig	indexDefaults()	The default configuration for the Elasticsearch indexes.
Map<String,HibernateSearchBackendElasticsearchRuntimeConfig.IndexConfig>	indexes()	Per-index configuration overrides.
HibernateSearchBackendElasticsearchRuntimeConfig.LayoutConfig	layout()	Configuration for the index layout.
int	maxConnections()	The maximum number of connections to all the Elasticsearch servers.
int	maxConnectionsPerRoute()	The maximum number of connections per Elasticsearch server.
Optional<String>	password()	The password used for authentication.
HibernateSearchBackendElasticsearchRuntimeConfig.ElasticsearchClientProtocol	protocol()	The protocol to use when contacting Elasticsearch servers.
HibernateSearchBackendElasticsearchRuntimeConfig.QueryConfig	query()	Configuration for search queries to this backend.
Duration	readTimeout()	The timeout when reading responses from an Elasticsearch server.
Optional<Duration>	requestTimeout()	The timeout when executing a request to an Elasticsearch server.
HibernateSearchBackendElasticsearchRuntimeConfig.ThreadPoolConfig	threadPool()	Configuration for the thread pool assigned to the backend.
Optional<String>	username()	The username used for authentication.
HibernateSearchBackendElasticsearchRuntimeConfig.VersionCheckConfig	versionCheck()	Configuration for version checks on this backend.

Method Details

hosts

@WithDefault("localhost:9200")
List<String> hosts()

The list of hosts of the Elasticsearch servers.

protocol

@WithDefault("http")
HibernateSearchBackendElasticsearchRuntimeConfig.ElasticsearchClientProtocol protocol()

The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.

username

Optional<String> username()

The username used for authentication.

password

Optional<String> password()

The password used for authentication.

connectionTimeout

@WithDefault("1S")
Duration connectionTimeout()

The timeout when establishing a connection to an Elasticsearch server.

readTimeout

@WithDefault("30S")
Duration readTimeout()

The timeout when reading responses from an Elasticsearch server.

requestTimeout

Optional<Duration> requestTimeout()

The timeout when executing a request to an Elasticsearch server. This includes the time needed to wait for a connection to be available, send the request and read the response.

maxConnections

@WithDefault("20")
int maxConnections()

The maximum number of connections to all the Elasticsearch servers.

maxConnectionsPerRoute

@WithDefault("10")
int maxConnectionsPerRoute()

The maximum number of connections per Elasticsearch server.

discovery

HibernateSearchBackendElasticsearchRuntimeConfig.DiscoveryConfig discovery()

Configuration for the automatic discovery of new Elasticsearch nodes.

threadPool

HibernateSearchBackendElasticsearchRuntimeConfig.ThreadPoolConfig threadPool()

Configuration for the thread pool assigned to the backend.

query

HibernateSearchBackendElasticsearchRuntimeConfig.QueryConfig query()

Configuration for search queries to this backend.

versionCheck

HibernateSearchBackendElasticsearchRuntimeConfig.VersionCheckConfig versionCheck()

Configuration for version checks on this backend.

indexDefaults

@WithParentName
HibernateSearchBackendElasticsearchRuntimeConfig.IndexConfig indexDefaults()

The default configuration for the Elasticsearch indexes.

indexes

@ConfigDocSection
@ConfigDocMapKey("index-name")
Map<String,HibernateSearchBackendElasticsearchRuntimeConfig.IndexConfig> indexes()

Per-index configuration overrides.

layout

HibernateSearchBackendElasticsearchRuntimeConfig.LayoutConfig layout()

Configuration for the index layout.