Package org.opensearch.client.opensearch.generic

Class OpenSearchGenericClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchGenericClient>

org.opensearch.client.opensearch.generic.OpenSearchGenericClient

public class OpenSearchGenericClient
extends ApiClient<OpenSearchTransport,OpenSearchGenericClient>

Client for the generic HTTP requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSearchGenericClient.ClientOptions	Generic client options

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchGenericClient(OpenSearchTransport transport)
OpenSearchGenericClient(OpenSearchTransport transport, TransportOptions transportOptions)
OpenSearchGenericClient(OpenSearchTransport transport, TransportOptions transportOptions, OpenSearchGenericClient.ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Response	execute(Request request)	Executes generic HTTP request and returns generic HTTP response.
CompletableFuture<Response>	executeAsync(Request request)	Asynchronously executes generic HTTP request and returns generic HTTP response.
OpenSearchGenericClient	withClientOptions(OpenSearchGenericClient.ClientOptions clientOptions)
OpenSearchGenericClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchGenericClient

public OpenSearchGenericClient(OpenSearchTransport transport)

OpenSearchGenericClient

public OpenSearchGenericClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

OpenSearchGenericClient

public OpenSearchGenericClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions,
 OpenSearchGenericClient.ClientOptions clientOptions)

Method Details

withClientOptions

public OpenSearchGenericClient withClientOptions(OpenSearchGenericClient.ClientOptions clientOptions)

withTransportOptions

public OpenSearchGenericClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchGenericClient>

execute

public Response execute(Request request)
                 throws IOException

Executes generic HTTP request and returns generic HTTP response.

Parameters:

request - generic HTTP request

Returns:

generic HTTP response

Throws:

IOException - I/O exception

executeAsync

public CompletableFuture<Response> executeAsync(Request request)

Asynchronously executes generic HTTP request and returns generic HTTP response.

Parameters:

request - generic HTTP request

Returns:

generic HTTP response future