Package org.hibernate.search.backend.elasticsearch.cfg.spi

Class ElasticsearchBackendSpiSettings

java.lang.Object

org.hibernate.search.backend.elasticsearch.cfg.spi.ElasticsearchBackendSpiSettings

public final class ElasticsearchBackendSpiSettings
extends Object

Configuration properties for the Elasticsearch backend that are considered SPI (and not API).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElasticsearchBackendSpiSettings.Defaults
static class	ElasticsearchBackendSpiSettings.Radicals	Configuration property keys without the prefix.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKEND_WORK_EXECUTOR_PROVIDER	The ElasticsearchWorkExecutorProvider used to create work executors.
static final String	CLIENT_INSTANCE	An external Elasticsearch client instance that Hibernate Search should use for all requests to Elasticsearch.
static final String	PREFIX	The prefix expected for the key of every Hibernate Search configuration property.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The prefix expected for the key of every Hibernate Search configuration property.

See Also:

• Constant Field Values

BACKEND_WORK_EXECUTOR_PROVIDER

public static final String BACKEND_WORK_EXECUTOR_PROVIDER

The ElasticsearchWorkExecutorProvider used to create work executors.

Expects a reference to a bean of type ElasticsearchWorkExecutorProvider.

Defaults to ElasticsearchBackendSpiSettings.Defaults.BACKEND_WORK_EXECUTOR_PROVIDER.

See Also:

• Constant Field Values

CLIENT_INSTANCE

public static final String CLIENT_INSTANCE

An external Elasticsearch client instance that Hibernate Search should use for all requests to Elasticsearch.

If this is set, Hibernate Search will not attempt to create its own Elasticsearch, and all other client-related configuration properties (hosts/uris, authentication, discovery, timeouts, max connections, configurer, ...) will be ignored.

Expects a reference to a bean of type RestClient.

Defaults to nothing: if no client instance is provided, Hibernate Search will create its own.

WARNING - Incubating API: the underlying client class may change without prior notice.

See Also:

• invalid reference

  The core documentation of configuration properties,
   which includes a description of the "bean reference" properties and accepted values.

• Constant Field Values