Package org.opensearch.client.opensearch

Class OpenSearchClient

java.lang.Object

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

org.opensearch.client.opensearch.OpenSearchClientBase<OpenSearchClient>

org.opensearch.client.opensearch.OpenSearchClient

public class OpenSearchClient
extends OpenSearchClientBase<OpenSearchClient>

Client for the namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchClient(OpenSearchTransport transport)
OpenSearchClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
BulkResponse	bulk()	Allows to perform multiple index/update/delete operations in a single request.
final BulkResponse	bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)	Allows to perform multiple index/update/delete operations in a single request.
BulkResponse	bulk(BulkRequest request)	Allows to perform multiple index/update/delete operations in a single request.
final <TDocument> CreateResponse	create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)	Creates a new document in the index.
<TDocument> CreateResponse	create(CreateRequest<TDocument> request)	Creates a new document in the index.
final <TDocument> ExplainResponse<TDocument>	explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, Class<TDocument> tDocumentClass)	Returns information about why a specific matches (or doesn't match) a query.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, Class<TDocument> tDocumentClass)	Returns information about why a specific matches (or doesn't match) a query.
OpenSearchGenericClient	generic()
final <TDocument> GetResponse<TDocument>	get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, Class<TDocument> tDocumentClass)	Returns a document.
<TDocument> GetResponse<TDocument>	get(GetRequest request, Class<TDocument> tDocumentClass)	Returns a document.
final <TDocument> GetSourceResponse<TDocument>	getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, Class<TDocument> tDocumentClass)	Returns the source of a document.
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, Class<TDocument> tDocumentClass)	Returns the source of a document.
final <TDocument> IndexResponse	index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)	Creates or updates a document in an index.
<TDocument> IndexResponse	index(IndexRequest<TDocument> request)	Creates or updates a document in an index.
final <TDocument> MgetResponse<TDocument>	mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
final <TDocument> MsearchResponse<TDocument>	msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
final <TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one request.
final <TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
final <TDocument> ScrollResponse<TDocument>	scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
final <TDocument> SearchResponse<TDocument>	search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, Class<TDocument> tDocumentClass)	Returns results matching a query.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, Class<TDocument> tDocumentClass)	Returns results matching a query.
final <TDocument> SearchTemplateResponse<TDocument>	searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, Class<TDocument> tDocumentClass)	Allows to use the Mustache language to pre-render a search definition.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, Class<TDocument> tDocumentClass)	Allows to use the Mustache language to pre-render a search definition.
final <TDocument> TermvectorsResponse	termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)	Returns information and statistics about terms in the fields of a particular document.
<TDocument> TermvectorsResponse	termvectors(TermvectorsRequest<TDocument> request)	Returns information and statistics about terms in the fields of a particular document.
final <TDocument, TPartialDocument> UpdateResponse<TDocument>	update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
<TDocument, TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
OpenSearchClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.opensearch.OpenSearchClientBase

cat, clearScroll, clearScroll, clearScroll, cluster, count, count, count, createPit, createPit, danglingIndices, delete, delete, deleteAllPits, deleteAllPits, deleteAllPits, deleteByQuery, deleteByQuery, deleteByQueryRethrottle, deleteByQueryRethrottle, deletePit, deletePit, deleteScript, deleteScript, exists, exists, existsSource, existsSource, fieldCaps, fieldCaps, fieldCaps, getAllPits, getAllPits, getAllPits, getScript, getScript, getScriptContext, getScriptContext, getScriptContext, getScriptLanguages, getScriptLanguages, getScriptLanguages, indices, info, info, info, ingest, ml, mtermvectors, mtermvectors, mtermvectors, nodes, ping, ping, ping, putScript, putScript, rankEval, rankEval, reindex, reindex, reindexRethrottle, reindexRethrottle, renderSearchTemplate, renderSearchTemplate, renderSearchTemplate, searchPipeline, searchShards, searchShards, searchShards, snapshot, tasks, updateByQuery, updateByQuery, updateByQueryRethrottle, updateByQueryRethrottle

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

OpenSearchClient

public OpenSearchClient(OpenSearchTransport transport)

OpenSearchClient

public OpenSearchClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchClient>

generic

public OpenSearchGenericClient generic()

bulk

public BulkResponse bulk(BulkRequest request)
                  throws IOException,
OpenSearchException

Allows to perform multiple index/update/delete operations in a single request.

Throws:

IOException

OpenSearchException

bulk

public final BulkResponse bulk(Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)
                        throws IOException,
OpenSearchException

Allows to perform multiple index/update/delete operations in a single request.

Parameters:

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

Throws:

IOException

OpenSearchException

bulk

public BulkResponse bulk()
                  throws IOException,
OpenSearchException

Allows to perform multiple index/update/delete operations in a single request.

Throws:

IOException

OpenSearchException

create

public <TDocument> CreateResponse create(CreateRequest<TDocument> request)
                                  throws IOException,
OpenSearchException

Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

Throws:

IOException

OpenSearchException

create

public final <TDocument> CreateResponse create(Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)
                                        throws IOException,
OpenSearchException

Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

Parameters:

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

Throws:

IOException

OpenSearchException

explain

public <TDocument> ExplainResponse<TDocument> explain(ExplainRequest request,
 Class<TDocument> tDocumentClass)
                                               throws IOException,
OpenSearchException

Returns information about why a specific matches (or doesn't match) a query.

Throws:

IOException

OpenSearchException

explain

public final <TDocument> ExplainResponse<TDocument> explain(Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                     throws IOException,
OpenSearchException

Returns information about why a specific matches (or doesn't match) a query.

Parameters:

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

Throws:

IOException

OpenSearchException

get

public <TDocument> GetResponse<TDocument> get(GetRequest request,
 Class<TDocument> tDocumentClass)
                                       throws IOException,
OpenSearchException

Returns a document.

Throws:

IOException

OpenSearchException

get

public final <TDocument> GetResponse<TDocument> get(Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
OpenSearchException

Returns a document.

Parameters:

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

Throws:

IOException

OpenSearchException

getSource

public <TDocument> GetSourceResponse<TDocument> getSource(GetSourceRequest request,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
OpenSearchException

Returns the source of a document.

Throws:

IOException

OpenSearchException

getSource

public final <TDocument>
GetSourceResponse<TDocument> getSource(Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn,
 Class<TDocument> tDocumentClass)
                                throws IOException,
OpenSearchException

Returns the source of a document.

Parameters:

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

Throws:

IOException

OpenSearchException

index

public <TDocument> IndexResponse index(IndexRequest<TDocument> request)
                                throws IOException,
OpenSearchException

Creates or updates a document in an index.

Throws:

IOException

OpenSearchException

index

public final <TDocument> IndexResponse index(Function<IndexRequest.Builder<TDocument>,ObjectBuilder<IndexRequest<TDocument>>> fn)
                                      throws IOException,
OpenSearchException

Creates or updates a document in an index.

Parameters:

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

Throws:

IOException

OpenSearchException

mget

public <TDocument> MgetResponse<TDocument> mget(MgetRequest request,
 Class<TDocument> tDocumentClass)
                                         throws IOException,
OpenSearchException

Allows to get multiple documents in one request.

Throws:

IOException

OpenSearchException

mget

public final <TDocument> MgetResponse<TDocument> mget(Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn,
 Class<TDocument> tDocumentClass)
                                               throws IOException,
OpenSearchException

Allows to get multiple documents in one request.

Parameters:

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

Throws:

IOException

OpenSearchException

msearch

public <TDocument> MsearchResponse<TDocument> msearch(MsearchRequest request,
 Class<TDocument> tDocumentClass)
                                               throws IOException,
OpenSearchException

Allows to execute several search operations in one request.

Throws:

IOException

OpenSearchException

msearch

public final <TDocument> MsearchResponse<TDocument> msearch(Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                     throws IOException,
OpenSearchException

Allows to execute several search operations in one request.

Parameters:

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

Throws:

IOException

OpenSearchException

msearchTemplate

public <TDocument>
MsearchTemplateResponse<TDocument> msearchTemplate(MsearchTemplateRequest request,
 Class<TDocument> tDocumentClass)
                                            throws IOException,
OpenSearchException

Allows to execute several search template operations in one request.

Throws:

IOException

OpenSearchException

msearchTemplate

public final <TDocument>
MsearchTemplateResponse<TDocument> msearchTemplate(Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn,
 Class<TDocument> tDocumentClass)
                                            throws IOException,
OpenSearchException

Allows to execute several search template operations in one request.

Parameters:

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

Throws:

IOException

OpenSearchException

scriptsPainlessExecute

public <TResult>
ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(ScriptsPainlessExecuteRequest request,
 Class<TResult> tResultClass)
                                                        throws IOException,
OpenSearchException

Allows an arbitrary script to be executed and a result to be returned

Throws:

IOException

OpenSearchException

scriptsPainlessExecute

public final <TResult>
ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn,
 Class<TResult> tResultClass)
                                                        throws IOException,
OpenSearchException

Allows an arbitrary script to be executed and a result to be returned

Parameters:

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

Throws:

IOException

OpenSearchException

scroll

public <TDocument> ScrollResponse<TDocument> scroll(ScrollRequest request,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
OpenSearchException

Allows to retrieve a large numbers of results from a single search request.

Throws:

IOException

OpenSearchException

scroll

public final <TDocument> ScrollResponse<TDocument> scroll(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
OpenSearchException

Allows to retrieve a large numbers of results from a single search request.

Parameters:

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

Throws:

IOException

OpenSearchException

search

public <TDocument> SearchResponse<TDocument> search(SearchRequest request,
 Class<TDocument> tDocumentClass)
                                             throws IOException,
OpenSearchException

Returns results matching a query.

Throws:

IOException

OpenSearchException

search

public final <TDocument> SearchResponse<TDocument> search(Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn,
 Class<TDocument> tDocumentClass)
                                                   throws IOException,
OpenSearchException

Returns results matching a query.

Parameters:

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

Throws:

IOException

OpenSearchException

searchTemplate

public <TDocument>
SearchTemplateResponse<TDocument> searchTemplate(SearchTemplateRequest request,
 Class<TDocument> tDocumentClass)
                                          throws IOException,
OpenSearchException

Allows to use the Mustache language to pre-render a search definition.

Throws:

IOException

OpenSearchException

searchTemplate

public final <TDocument>
SearchTemplateResponse<TDocument> searchTemplate(Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn,
 Class<TDocument> tDocumentClass)
                                          throws IOException,
OpenSearchException

Allows to use the Mustache language to pre-render a search definition.

Parameters:

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

Throws:

IOException

OpenSearchException

termvectors

public <TDocument> TermvectorsResponse termvectors(TermvectorsRequest<TDocument> request)
                                            throws IOException,
OpenSearchException

Returns information and statistics about terms in the fields of a particular document.

Throws:

IOException

OpenSearchException

termvectors

public final <TDocument> TermvectorsResponse termvectors(Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)
                                                  throws IOException,
OpenSearchException

Returns information and statistics about terms in the fields of a particular document.

Parameters:

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

Throws:

IOException

OpenSearchException

update

public <TDocument,
TPartialDocument>
UpdateResponse<TDocument> update(UpdateRequest<TDocument,TPartialDocument> request,
 Class<TDocument> tDocumentClass)
                          throws IOException,
OpenSearchException

Updates a document with a script or partial document.

Throws:

IOException

OpenSearchException

update

public final <TDocument,
TPartialDocument>
UpdateResponse<TDocument> update(Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn,
 Class<TDocument> tDocumentClass)
                          throws IOException,
OpenSearchException

Updates a document with a script or partial document.

Parameters:

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

Throws:

IOException

OpenSearchException