Package org.opensearch.client.opensearch

Class OpenSearchClientBase<Self extends OpenSearchClientBase<Self>>

java.lang.Object

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

org.opensearch.client.opensearch.OpenSearchClientBase<Self>

Direct Known Subclasses:

OpenSearchClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class OpenSearchClientBase<Self extends OpenSearchClientBase<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
OpenSearchClientBase(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
OpenSearchMlClient	ml()
OpenSearchSearchPipelineClient	searchPipeline()
SearchShardsResponse	searchShards()	Returns information about the indexes and shards that a search request would be executed against.
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.
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

OpenSearchClientBase

public OpenSearchClientBase(OpenSearchTransport transport,
                            @Nullable
                            TransportOptions transportOptions)

Method Detail

ml

public OpenSearchMlClient ml()

searchPipeline

public OpenSearchSearchPipelineClient searchPipeline()

searchShards

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