org.springframework.data.elasticsearch.client

Interface ClientConfiguration.TerminalClientConfigurationBuilder

All Known Subinterfaces:

ClientConfiguration.MaybeSecureClientConfigurationBuilder

Enclosing interface:

ClientConfiguration

public static interface ClientConfiguration.TerminalClientConfigurationBuilder

Author:

Christoph Strobl, Mark Paluch

Method Summary

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	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	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.

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

build

ClientConfiguration build()

Build the ClientConfiguration object.

Returns:

the ClientConfiguration object.