Package org.opensearch.client

Class RestClientBuilder

java.lang.Object

org.opensearch.client.RestClientBuilder

public final class RestClientBuilder
extends java.lang.Object

Helps creating a new RestClient. Allows to set the most common http client configuration options when internally creating the underlying HttpAsyncClient. Also allows to provide an externally created HttpAsyncClient in case additional customization is needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RestClientBuilder.HttpClientConfigCallback	Callback used to customize the CloseableHttpClient instance used by a RestClient instance.
static interface	RestClientBuilder.RequestConfigCallback	Callback used the default RequestConfig being set to the CloseableHttpClient

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_CONNECT_TIMEOUT_MILLIS
static int	DEFAULT_MAX_CONN_PER_ROUTE
static int	DEFAULT_MAX_CONN_TOTAL
static int	DEFAULT_SOCKET_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method	Description
RestClient	build()	Creates a new RestClient based on the provided configuration.
static java.lang.String	cleanPathPrefix(java.lang.String pathPrefix)
RestClientBuilder	setCompressionEnabled(boolean compressionEnabled)	Whether the REST client should compress requests using gzip content encoding and add the "Accept-Encoding: gzip" header to receive compressed responses.
RestClientBuilder	setDefaultHeaders(org.apache.http.Header[] defaultHeaders)	Sets the default request headers, which will be sent along with each request.
RestClientBuilder	setFailureListener(RestClient.FailureListener failureListener)	Sets the RestClient.FailureListener to be notified for each request failure
RestClientBuilder	setHttpClientConfigCallback(RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback)	Sets the RestClientBuilder.HttpClientConfigCallback to be used to customize http client configuration
RestClientBuilder	setNodeSelector(NodeSelector nodeSelector)	Sets the NodeSelector to be used for all requests.
RestClientBuilder	setPathPrefix(java.lang.String pathPrefix)	Sets the path's prefix for every request used by the http client.
RestClientBuilder	setRequestConfigCallback(RestClientBuilder.RequestConfigCallback requestConfigCallback)	Sets the RestClientBuilder.RequestConfigCallback to be used to customize http client configuration
RestClientBuilder	setStrictDeprecationMode(boolean strictDeprecationMode)	Whether the REST client should return any response containing at least one warning header as a failure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONNECT_TIMEOUT_MILLIS

public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_MILLIS

public static final int DEFAULT_SOCKET_TIMEOUT_MILLIS

See Also:

Constant Field Values

DEFAULT_MAX_CONN_PER_ROUTE

public static final int DEFAULT_MAX_CONN_PER_ROUTE

See Also:

Constant Field Values

DEFAULT_MAX_CONN_TOTAL

public static final int DEFAULT_MAX_CONN_TOTAL

See Also:

Constant Field Values

Method Detail

setDefaultHeaders

public RestClientBuilder setDefaultHeaders(org.apache.http.Header[] defaultHeaders)

Sets the default request headers, which will be sent along with each request.

Request-time headers will always overwrite any default headers.

Throws:

java.lang.NullPointerException - if defaultHeaders or any header is null.

setFailureListener

public RestClientBuilder setFailureListener(RestClient.FailureListener failureListener)

Sets the RestClient.FailureListener to be notified for each request failure

Throws:

java.lang.NullPointerException - if failureListener is null.

setHttpClientConfigCallback

public RestClientBuilder setHttpClientConfigCallback(RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback)

Sets the RestClientBuilder.HttpClientConfigCallback to be used to customize http client configuration

Throws:

java.lang.NullPointerException - if httpClientConfigCallback is null.

setRequestConfigCallback

public RestClientBuilder setRequestConfigCallback(RestClientBuilder.RequestConfigCallback requestConfigCallback)

Sets the RestClientBuilder.RequestConfigCallback to be used to customize http client configuration

Throws:

java.lang.NullPointerException - if requestConfigCallback is null.

setPathPrefix

public RestClientBuilder setPathPrefix(java.lang.String pathPrefix)

Sets the path's prefix for every request used by the http client.

For example, if this is set to "/my/path", then any client request will become "/my/path/" + endpoint.

In essence, every request's endpoint is prefixed by this pathPrefix. The path prefix is useful for when OpenSearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; it is not intended for other purposes and it should not be supplied in other scenarios.

Throws:

java.lang.NullPointerException - if pathPrefix is null.

java.lang.IllegalArgumentException - if pathPrefix is empty, or ends with more than one '/'.

cleanPathPrefix

public static java.lang.String cleanPathPrefix(java.lang.String pathPrefix)

setNodeSelector

public RestClientBuilder setNodeSelector(NodeSelector nodeSelector)

Sets the NodeSelector to be used for all requests.

Throws:

java.lang.NullPointerException - if the provided nodeSelector is null

setStrictDeprecationMode

public RestClientBuilder setStrictDeprecationMode(boolean strictDeprecationMode)

Whether the REST client should return any response containing at least one warning header as a failure.

setCompressionEnabled

public RestClientBuilder setCompressionEnabled(boolean compressionEnabled)

Whether the REST client should compress requests using gzip content encoding and add the "Accept-Encoding: gzip" header to receive compressed responses.

build

public RestClient build()

Creates a new RestClient based on the provided configuration.