Package org.opensearch.client.opensearch

Class OpenSearchAsyncClientBase<Self extends OpenSearchAsyncClientBase<Self>>

java.lang.Object

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

org.opensearch.client.opensearch.OpenSearchAsyncClientBase<Self>

Direct Known Subclasses:

OpenSearchAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchAsyncClientBase<Self extends OpenSearchAsyncClientBase<Self>>
extends ApiClient<OpenSearchTransport,Self>

Client for the namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchAsyncClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
OpenSearchMlAsyncClient	ml()
OpenSearchSearchPipelineAsyncClient	searchPipeline()
java.util.concurrent.CompletableFuture<SearchShardsResponse>	searchShards()	Returns information about the indexes and shards that a search request would be executed against.
java.util.concurrent.CompletableFuture<SearchShardsResponse>	searchShards(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)	Returns information about the indexes and shards that a search request would be executed against.
java.util.concurrent.CompletableFuture<SearchShardsResponse>	searchShards(SearchShardsRequest request)	Returns information about the indexes and shards that a search request would be executed against.

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchAsyncClientBase

public OpenSearchAsyncClientBase(OpenSearchTransport transport,
                                 @Nullable
                                 TransportOptions transportOptions)

Method Detail

ml

public OpenSearchMlAsyncClient ml()

searchPipeline

public OpenSearchSearchPipelineAsyncClient searchPipeline()

searchShards

public java.util.concurrent.CompletableFuture<SearchShardsResponse> searchShards(SearchShardsRequest request)
                                                                          throws java.io.IOException,
                                                                                 OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Throws:

java.io.IOException

OpenSearchException

searchShards

public final java.util.concurrent.CompletableFuture<SearchShardsResponse> searchShards(java.util.function.Function<SearchShardsRequest.Builder,ObjectBuilder<SearchShardsRequest>> fn)
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Parameters:

fn - a function that initializes a builder to create the SearchShardsRequest

Throws:

java.io.IOException

OpenSearchException

searchShards

public final java.util.concurrent.CompletableFuture<SearchShardsResponse> searchShards()
                                                                                throws java.io.IOException,
                                                                                       OpenSearchException

Returns information about the indexes and shards that a search request would be executed against.

Throws:

java.io.IOException

OpenSearchException