Package org.opensearch.client

Class RequestOptions.Builder

java.lang.Object

org.opensearch.client.RequestOptions.Builder

Enclosing class:

RequestOptions

public static class RequestOptions.Builder
extends java.lang.Object

Builds RequestOptions. Get one by calling RequestOptions.toBuilder() on RequestOptions.DEFAULT or any other RequestOptions.

Method Summary

Modifier and Type	Method	Description
RequestOptions.Builder	addHeader(java.lang.String name, java.lang.String value)	Add the provided header to the request.
RequestOptions	build()	Build the RequestOptions.
void	setHttpAsyncResponseConsumerFactory(HttpAsyncResponseConsumerFactory httpAsyncResponseConsumerFactory)	Set the HttpAsyncResponseConsumerFactory used to create one HttpAsyncResponseConsumer callback per retry.
RequestOptions.Builder	setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)	set RequestConfig, which can set socketTimeout, connectTimeout and so on by request
void	setWarningsHandler(WarningsHandler warningsHandler)	How this request should handle warnings.

Methods inherited from class java.lang.Object

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

Method Details

build

public RequestOptions build()

Build the RequestOptions.

addHeader

public RequestOptions.Builder addHeader(java.lang.String name, java.lang.String value)

Add the provided header to the request.

setHttpAsyncResponseConsumerFactory

public void setHttpAsyncResponseConsumerFactory(HttpAsyncResponseConsumerFactory httpAsyncResponseConsumerFactory)

Set the HttpAsyncResponseConsumerFactory used to create one HttpAsyncResponseConsumer callback per retry. Controls how the response body gets streamed from a non-blocking HTTP connection on the client side.

setWarningsHandler

public void setWarningsHandler(WarningsHandler warningsHandler)

How this request should handle warnings. If null (the default) then this request will default to the behavior dictacted by RestClientBuilder.setStrictDeprecationMode(boolean).

This can be set to WarningsHandler.PERMISSIVE if the client should ignore all warnings which is the same behavior as setting strictDeprecationMode to true. It can be set to WarningsHandler.STRICT if the client should fail if there are any warnings which is the same behavior as settings strictDeprecationMode to false.

It can also be set to a custom implementation of WarningsHandler to permit only certain warnings or to fail the request if the warnings returned don't exactly match some set.

setRequestConfig

public RequestOptions.Builder setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)

set RequestConfig, which can set socketTimeout, connectTimeout and so on by request

Parameters:

requestConfig - http client RequestConfig

Returns:

Builder