Package org.springframework.boot.autoconfigure.elasticsearch

Interface ElasticsearchConnectionDetails

All Superinterfaces:

ConnectionDetails

public interface ElasticsearchConnectionDetails
extends ConnectionDetails

Details required to establish a connection to an Elasticsearch service.

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ElasticsearchConnectionDetails.Node	An Elasticsearch node.

Method Summary

Modifier and Type	Method	Description
List<ElasticsearchConnectionDetails.Node>	getNodes()	List of the Elasticsearch nodes to use.
default String	getPassword()	Password for authentication with Elasticsearch.
default String	getPathPrefix()	Prefix added to the path of every request sent to Elasticsearch.
default String	getUsername()	Username for authentication with Elasticsearch.

Method Details

getNodes

List<ElasticsearchConnectionDetails.Node> getNodes()

List of the Elasticsearch nodes to use.

Returns:

list of the Elasticsearch nodes to use

getUsername

default String getUsername()

Username for authentication with Elasticsearch.

Returns:

username for authentication with Elasticsearch or null

getPassword

default String getPassword()

Password for authentication with Elasticsearch.

Returns:

password for authentication with Elasticsearch or null

getPathPrefix

default String getPathPrefix()

Prefix added to the path of every request sent to Elasticsearch.

Returns:

prefix added to the path of every request sent to Elasticsearch or null