ClientConfiguration (Spring Data Elasticsearch 4.1.5 API)

```
public interface ClientConfiguration
```
Configuration interface exposing common client configuration properties for Elasticsearch clients.

Since:

3.2

Author:

Mark Paluch, Peter-Josef Meisch, Huw Ayling-Miller, Henrique Amaral

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint`
`static interface`	`ClientConfiguration.MaybeSecureClientConfigurationBuilder`
`static interface`	`ClientConfiguration.TerminalClientConfigurationBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint`	`builder()` Creates a new `ClientConfigurationBuilder` instance.
`static ClientConfiguration`	`create(InetSocketAddress socketAddress)` Creates a new `ClientConfiguration` instance configured to a single host given `InetSocketAddress`.
`static ClientConfiguration`	`create(String hostAndPort)` Creates a new `ClientConfiguration` instance configured to a single host given `hostAndPort`.
`Duration`	`getConnectTimeout()` Returns the `connect timeout`.
`HttpHeaders`	`getDefaultHeaders()` Obtain the `HttpHeaders` to be used by default.
`List<InetSocketAddress>`	`getEndpoints()` Returns the configured endpoints.
`Supplier<HttpHeaders>`	`getHeadersSupplier()`
`Optional<HostnameVerifier>`	`getHostNameVerifier()` Returns the `HostnameVerifier` to use.
`String`	`getPathPrefix()` Returns the path prefix that should be prepended to HTTP(s) requests for Elasticsearch behind a proxy.
`Optional<String>`	`getProxy()` returns an optionally set proxy in the form host:port
`Duration`	`getSocketTimeout()` Returns the `socket timeout` which is typically applied as SO-timeout/read timeout.
`Optional<SSLContext>`	`getSslContext()` Returns the `SSLContext` to use.
`Function<WebClient,WebClient>`	`getWebClientConfigurer()`
`static ClientConfiguration`	`localhost()` Creates a new `ClientConfiguration` instance configured to localhost.
`boolean`	`useSsl()` Returns true when the client should use SSL.

- Method Detail
  - builder
```
static ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint builder()
```
    Creates a new ClientConfigurationBuilder instance.
    
    Returns:
    
    a new ClientConfigurationBuilder instance.
  - localhost
```
static ClientConfiguration localhost()
```
    Creates a new ClientConfiguration instance configured to localhost.
```
 // "localhost:9200"
 ClientConfiguration configuration = ClientConfiguration.localhost();
 
```
    Returns:
    
    a new ClientConfiguration instance
    
    See Also:
    
    ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint.connectedToLocalhost()
  - create
```
static ClientConfiguration create(String hostAndPort)
```
    Creates a new ClientConfiguration instance configured to a single host given hostAndPort.
    For example given the endpoint http://localhost:9200
```
 ClientConfiguration configuration = ClientConfiguration.create("localhost:9200");
 
```
    Returns:
    
    a new ClientConfigurationBuilder instance.
  - create
```
static ClientConfiguration create(InetSocketAddress socketAddress)
```
    Creates a new ClientConfiguration instance configured to a single host given InetSocketAddress.
    For example given the endpoint http://localhost:9200
```
 ClientConfiguration configuration = ClientConfiguration
                .create(InetSocketAddress.createUnresolved("localhost", 9200));
 
```
    Returns:
    
    a new ClientConfigurationBuilder instance.
  - getEndpoints
```
List<InetSocketAddress> getEndpoints()
```
    Returns the configured endpoints.
    
    Returns:
    
    the configured endpoints.
  - getDefaultHeaders
```
HttpHeaders getDefaultHeaders()
```
    Obtain the HttpHeaders to be used by default.
    
    Returns:
    
    the HttpHeaders to be used by default.
  - useSsl
```
boolean useSsl()
```
    Returns true when the client should use SSL.
    
    Returns:
    
    true when the client should use SSL.
  - getSslContext
```
Optional<SSLContext> getSslContext()
```
    Returns the SSLContext to use. Can be Optional.empty() if unconfigured.
    
    Returns:
    
    the SSLContext to use. Can be Optional.empty() if unconfigured.
  - getHostNameVerifier
```
Optional<HostnameVerifier> getHostNameVerifier()
```
    Returns the HostnameVerifier to use. Can be Optional.empty() if unconfigured.
    
    Returns:
    
    the HostnameVerifier to use. Can be Optional.empty() if unconfigured.
  - getConnectTimeout
```
Duration getConnectTimeout()
```
    Returns the connect timeout.
    
    See Also:
    
    Socket.connect(SocketAddress, int), ChannelOption.CONNECT_TIMEOUT_MILLIS
  - getSocketTimeout
```
Duration getSocketTimeout()
```
    Returns the socket timeout which is typically applied as SO-timeout/read timeout.
    
    See Also:
    
    Socket.setSoTimeout(int), ReadTimeoutHandler, WriteTimeoutHandler
  - getPathPrefix
```
@Nullable
String getPathPrefix()
```
    Returns the path prefix that should be prepended to HTTP(s) requests for Elasticsearch behind a proxy.
    
    Returns:
    
    the path prefix.
    
    Since:
    
    4.0
  - getProxy
```
Optional<String> getProxy()
```
    returns an optionally set proxy in the form host:port
    
    Returns:
    
    the optional proxy
    
    Since:
    
    4.0
  - getWebClientConfigurer
```
Function<WebClient,WebClient> getWebClientConfigurer()
```
    Returns:
    
    the function for configuring a WebClient.
  - getHeadersSupplier
```
Supplier<HttpHeaders> getHeadersSupplier()
```
    Returns:
    
    the supplier for custom headers.

Interface ClientConfiguration

Nested Class Summary

Method Summary

Method Detail

builder

localhost

create

create

getEndpoints

getDefaultHeaders

useSsl

getSslContext

getHostNameVerifier

getConnectTimeout

getSocketTimeout

getPathPrefix

getProxy

getWebClientConfigurer

getHeadersSupplier