ClientConfiguration.TerminalClientConfigurationBuilder (Spring Data Elasticsearch 4.3.0-M3 API)

All Known Subinterfaces:

ClientConfiguration.MaybeSecureClientConfigurationBuilder

Enclosing interface:

ClientConfiguration
```
public static interface ClientConfiguration.TerminalClientConfigurationBuilder
```
Author:

Christoph Strobl, Mark Paluch

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientConfiguration`	`build()` Build the `ClientConfiguration` object.
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withBasicAuth(String username, String password)` Configure the username and password to be sent as a Basic Authentication header
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withClientConfigurer(ClientConfiguration.ClientConfigurationCallback<?> clientConfigurer)` Register a `ClientConfiguration.ClientConfigurationCallback` to configure the client.
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withConnectTimeout(Duration timeout)` Configure a `Duration` connect timeout.
`default ClientConfiguration.TerminalClientConfigurationBuilder`	`withConnectTimeout(long millis)` Configure the milliseconds for the connect-timeout.
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withDefaultHeaders(HttpHeaders defaultHeaders)`
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withHeaders(Supplier<HttpHeaders> headers)` set a supplier for custom headers.
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withHttpClientConfigurer(org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigurer)` Deprecated. since 4.3, use `#withClientConfigurer(ClientConfigurationCallback)` with `RestClients.RestClientConfigurationCallback`
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withPathPrefix(String pathPrefix)` Configure the path prefix that will be prepended to any HTTP(s) requests
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withProxy(String proxy)`
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withSocketTimeout(Duration timeout)` Configure a `socket timeout` which is typically applied as SO-timeout/read timeout.
`default ClientConfiguration.TerminalClientConfigurationBuilder`	`withSocketTimeout(long millis)` Configure the milliseconds for the socket timeout.
`ClientConfiguration.TerminalClientConfigurationBuilder`	`withWebClientConfigurer(Function<WebClient,WebClient> webClientConfigurer)` Deprecated. since 4.3, use `#withClientConfigurer(ClientConfigurationCallback)` with `ReactiveRestClients.WebClientConfigurationCallback`

- Method Detail
  - withDefaultHeaders
```
ClientConfiguration.TerminalClientConfigurationBuilder withDefaultHeaders(HttpHeaders defaultHeaders)
```
    Parameters:
    
    defaultHeaders - must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
  - withConnectTimeout
```
default ClientConfiguration.TerminalClientConfigurationBuilder withConnectTimeout(long millis)
```
    Configure the milliseconds for the connect-timeout.
    
    Parameters:
    
    millis - the timeout to use.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
    
    See Also:
    
    withConnectTimeout(Duration)
  - withConnectTimeout
```
ClientConfiguration.TerminalClientConfigurationBuilder withConnectTimeout(Duration timeout)
```
    Configure a Duration connect timeout.
    
    Parameters:
    
    timeout - the timeout to use. Must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
    
    See Also:
    
    Socket.connect(SocketAddress, int), ChannelOption.CONNECT_TIMEOUT_MILLIS
  - withSocketTimeout
```
default ClientConfiguration.TerminalClientConfigurationBuilder withSocketTimeout(long millis)
```
    Configure the milliseconds for the socket timeout.
    
    Parameters:
    
    millis - the timeout to use.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
    
    See Also:
    
    withSocketTimeout(Duration)
  - withSocketTimeout
```
ClientConfiguration.TerminalClientConfigurationBuilder withSocketTimeout(Duration timeout)
```
    Configure a socket timeout which is typically applied as SO-timeout/read timeout.
    
    Parameters:
    
    timeout - the timeout to use. Must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
    
    See Also:
    
    Socket.setSoTimeout(int), ReadTimeoutHandler, WriteTimeoutHandler
  - withBasicAuth
```
ClientConfiguration.TerminalClientConfigurationBuilder withBasicAuth(String username,
                                                                     String password)
```
    Configure the username and password to be sent as a Basic Authentication header
    
    Parameters:
    
    username - the username. Must not be null.
    
    password - the password. Must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
  - withPathPrefix
```
ClientConfiguration.TerminalClientConfigurationBuilder withPathPrefix(String pathPrefix)
```
    Configure the path prefix that will be prepended to any HTTP(s) requests
    
    Parameters:
    
    pathPrefix - the pathPrefix.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder
    
    Since:
    
    4.0
  - withProxy
```
ClientConfiguration.TerminalClientConfigurationBuilder withProxy(String proxy)
```
    Parameters:
    
    proxy - a proxy formatted as String host:port.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder.
  - withWebClientConfigurer
```
@Deprecated
ClientConfiguration.TerminalClientConfigurationBuilder withWebClientConfigurer(Function<WebClient,WebClient> webClientConfigurer)
```
    Deprecated. since 4.3, use #withClientConfigurer(ClientConfigurationCallback) with ReactiveRestClients.WebClientConfigurationCallback
    
    set customization hook in case of a reactive configuration
    
    Parameters:
    
    webClientConfigurer - function to configure the WebClient
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder.
  - withHttpClientConfigurer
```
@Deprecated
ClientConfiguration.TerminalClientConfigurationBuilder withHttpClientConfigurer(org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigurer)
```
    Deprecated. since 4.3, use #withClientConfigurer(ClientConfigurationCallback) with RestClients.RestClientConfigurationCallback
    
    Register a {HttpClientConfigCallback} to configure the non-reactive REST client.
    
    Parameters:
    
    httpClientConfigurer - configuration callback, must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder.
    
    Since:
    
    4.2
  - withClientConfigurer
```
ClientConfiguration.TerminalClientConfigurationBuilder withClientConfigurer(ClientConfiguration.ClientConfigurationCallback<?> clientConfigurer)
```
    Register a ClientConfiguration.ClientConfigurationCallback to configure the client.
    
    Parameters:
    
    clientConfigurer - configuration callback, must not be null.
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder.
    
    Since:
    
    4.3
  - withHeaders
```
ClientConfiguration.TerminalClientConfigurationBuilder withHeaders(Supplier<HttpHeaders> headers)
```
    set a supplier for custom headers. This is invoked for every HTTP request to Elasticsearch to retrieve headers that should be sent with the request. A common use case is passing in authentication headers that may change.
    Note: When used in a reactive environment, the calling of Supplier.get() function must not do any blocking operations. It may return null.
    
    Parameters:
    
    headers - supplier function for headers, must not be null
    
    Returns:
    
    the ClientConfiguration.TerminalClientConfigurationBuilder.
    
    Since:
    
    4.0
  - build
```
ClientConfiguration build()
```
    Build the ClientConfiguration object.
    
    Returns:
    
    the ClientConfiguration object.

Interface ClientConfiguration.TerminalClientConfigurationBuilder

Method Summary

Method Detail

withDefaultHeaders

withConnectTimeout

withConnectTimeout

withSocketTimeout

withSocketTimeout

withBasicAuth

withPathPrefix

withProxy

withWebClientConfigurer

withHttpClientConfigurer

withClientConfigurer

withHeaders

build