Interface ElasticsearchConnectionDetails

All Superinterfaces:
org.springframework.boot.autoconfigure.service.connection.ConnectionDetails
public interface ElasticsearchConnectionDetails extends org.springframework.boot.autoconfigure.service.connection.ConnectionDetails
Details required to establish a connection to an Elasticsearch service.
Since:
4.0.0

  • 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
    default @Nullable String
    getApiKey()
    APIKey for authentication with Elasticsearch.
    List<ElasticsearchConnectionDetails.Node>
    getNodes()
    List of the Elasticsearch nodes to use.
    default @Nullable String
    getPassword()
    Password for authentication with Elasticsearch.
    default @Nullable String
    getPathPrefix()
    Prefix added to the path of every request sent to Elasticsearch.
    default @Nullable org.springframework.boot.ssl.SslBundle
    getSslBundle()
    SSL bundle to use.
    default @Nullable 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 @Nullable String getUsername()
      Username for authentication with Elasticsearch.
      Returns:
      username for authentication with Elasticsearch or null

    • getPassword

      default @Nullable String getPassword()
      Password for authentication with Elasticsearch.
      Returns:
      password for authentication with Elasticsearch or null

    • getApiKey

      default @Nullable String getApiKey()
      APIKey for authentication with Elasticsearch.
      Returns:
      the API key for authentication with Elasticsearch or null

    • getPathPrefix

      default @Nullable 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

    • getSslBundle

      default @Nullable org.springframework.boot.ssl.SslBundle getSslBundle()
      SSL bundle to use.
      Returns:
      the SSL bundle to use