Package org.opensearch.client.opensearch

Class OpenSearchClient

java.lang.Object

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

org.opensearch.client.opensearch.OpenSearchClient

public class OpenSearchClient
extends ApiClient<OpenSearchTransport,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.
BulkResponse	bulk(java.util.function.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.
OpenSearchCatClient	cat()
ClearScrollResponse	clearScroll()	Explicitly clears the search context for a scroll.
ClearScrollResponse	clearScroll(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)	Explicitly clears the search context for a scroll.
ClearScrollResponse	clearScroll(ClearScrollRequest request)	Explicitly clears the search context for a scroll.
OpenSearchClusterClient	cluster()
CountResponse	count()	Returns number of documents matching a query.
CountResponse	count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)	Returns number of documents matching a query.
CountResponse	count(CountRequest request)	Returns number of documents matching a query.
<TDocument> CreateResponse	create(java.util.function.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.
CreatePitResponse	createPit(java.util.function.Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)	Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.
CreatePitResponse	createPit(CreatePitRequest request)	Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.
OpenSearchDanglingIndicesClient	danglingIndices()
DeleteResponse	delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)	Removes a document from the index.
DeleteResponse	delete(DeleteRequest request)	Removes a document from the index.
DeleteByQueryResponse	deleteByQuery(java.util.function.Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)	Deletes documents matching the provided query.
DeleteByQueryResponse	deleteByQuery(DeleteByQueryRequest request)	Deletes documents matching the provided query.
DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular Delete By Query operation.
DeleteByQueryRethrottleResponse	deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Delete By Query operation.
DeletePitResponse	deletePit(java.util.function.Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)	Delete Point In Time
DeletePitResponse	deletePit(DeletePitRequest request)	Delete Point In Time
DeleteScriptResponse	deleteScript(java.util.function.Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)	Deletes a script.
DeleteScriptResponse	deleteScript(DeleteScriptRequest request)	Deletes a script.
BooleanResponse	exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)	Returns information about whether a document exists in an index.
BooleanResponse	exists(ExistsRequest request)	Returns information about whether a document exists in an index.
BooleanResponse	existsSource(java.util.function.Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)	Returns information about whether a document source exists in an index.
BooleanResponse	existsSource(ExistsSourceRequest request)	Returns information about whether a document source exists in an index.
<TDocument> ExplainResponse<TDocument>	explain(java.util.function.Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Returns information about why a specific matches (or doesn't match) a query.
<TDocument> ExplainResponse<TDocument>	explain(ExplainRequest request, java.lang.Class<TDocument> tDocumentClass)	Returns information about why a specific matches (or doesn't match) a query.
OpenSearchFeaturesClient	features()
FieldCapsResponse	fieldCaps()	Returns the information about the capabilities of fields among multiple indices.
FieldCapsResponse	fieldCaps(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)	Returns the information about the capabilities of fields among multiple indices.
FieldCapsResponse	fieldCaps(FieldCapsRequest request)	Returns the information about the capabilities of fields among multiple indices.
<TDocument> GetResponse<TDocument>	get(java.util.function.Function<GetRequest.Builder,ObjectBuilder<GetRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Returns a document.
<TDocument> GetResponse<TDocument>	get(GetRequest request, java.lang.Class<TDocument> tDocumentClass)	Returns a document.
GetScriptResponse	getScript(java.util.function.Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)	Returns a script.
GetScriptResponse	getScript(GetScriptRequest request)	Returns a script.
GetScriptContextResponse	getScriptContext()	Returns all script contexts.
GetScriptLanguagesResponse	getScriptLanguages()	Returns available script types, languages and contexts
<TDocument> GetSourceResponse<TDocument>	getSource(java.util.function.Function<GetSourceRequest.Builder,ObjectBuilder<GetSourceRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Returns the source of a document.
<TDocument> GetSourceResponse<TDocument>	getSource(GetSourceRequest request, java.lang.Class<TDocument> tDocumentClass)	Returns the source of a document.
<TDocument> IndexResponse	index(java.util.function.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.
OpenSearchIndicesClient	indices()
InfoResponse	info()	Returns basic information about the cluster.
OpenSearchIngestClient	ingest()
ListAllPitResponse	listAllPit()	List all Point In Time
<TDocument> MgetResponse<TDocument>	mget(java.util.function.Function<MgetRequest.Builder,ObjectBuilder<MgetRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
<TDocument> MgetResponse<TDocument>	mget(MgetRequest request, java.lang.Class<TDocument> tDocumentClass)	Allows to get multiple documents in one request.
<TDocument> MsearchResponse<TDocument>	msearch(java.util.function.Function<MsearchRequest.Builder,ObjectBuilder<MsearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
<TDocument> MsearchResponse<TDocument>	msearch(MsearchRequest request, java.lang.Class<TDocument> tDocumentClass)	Allows to execute several search operations in one request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one request.
<TDocument> MsearchTemplateResponse<TDocument>	msearchTemplate(MsearchTemplateRequest request, java.lang.Class<TDocument> tDocumentClass)	Allows to execute several search template operations in one request.
MtermvectorsResponse	mtermvectors()	Returns multiple termvectors in one request.
MtermvectorsResponse	mtermvectors(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)	Returns multiple termvectors in one request.
MtermvectorsResponse	mtermvectors(MtermvectorsRequest request)	Returns multiple termvectors in one request.
OpenSearchNodesClient	nodes()
BooleanResponse	ping()	Returns whether the cluster is running.
PutScriptResponse	putScript(java.util.function.Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)	Creates or updates a script.
PutScriptResponse	putScript(PutScriptRequest request)	Creates or updates a script.
RankEvalResponse	rankEval(java.util.function.Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)	Allows to evaluate the quality of ranked search results over a set of typical search queries
RankEvalResponse	rankEval(RankEvalRequest request)	Allows to evaluate the quality of ranked search results over a set of typical search queries
ReindexResponse	reindex()	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
ReindexResponse	reindex(java.util.function.Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
ReindexResponse	reindex(ReindexRequest request)	Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
ReindexRethrottleResponse	reindexRethrottle(java.util.function.Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)	Changes the number of requests per second for a particular Reindex operation.
ReindexRethrottleResponse	reindexRethrottle(ReindexRethrottleRequest request)	Changes the number of requests per second for a particular Reindex operation.
RenderSearchTemplateResponse	renderSearchTemplate()	Allows to use the Mustache language to pre-render a search definition.
RenderSearchTemplateResponse	renderSearchTemplate(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)	Allows to use the Mustache language to pre-render a search definition.
RenderSearchTemplateResponse	renderSearchTemplate(RenderSearchTemplateRequest request)	Allows to use the Mustache language to pre-render a search definition.
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(java.util.function.Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn, java.lang.Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
<TResult> ScriptsPainlessExecuteResponse<TResult>	scriptsPainlessExecute(ScriptsPainlessExecuteRequest request, java.lang.Class<TResult> tResultClass)	Allows an arbitrary script to be executed and a result to be returned
<TDocument> ScrollResponse<TDocument>	scroll(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> ScrollResponse<TDocument>	scroll(ScrollRequest request, java.lang.Class<TDocument> tDocumentClass)	Allows to retrieve a large numbers of results from a single search request.
<TDocument> SearchResponse<TDocument>	search(java.util.function.Function<SearchRequest.Builder,ObjectBuilder<SearchRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Returns results matching a query.
<TDocument> SearchResponse<TDocument>	search(SearchRequest request, java.lang.Class<TDocument> tDocumentClass)	Returns results matching a query.
SearchShardsResponse	searchShards()	Returns information about the indices 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 indices and shards that a search request would be executed against.
SearchShardsResponse	searchShards(SearchShardsRequest request)	Returns information about the indices and shards that a search request would be executed against.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn, java.lang.Class<TDocument> tDocumentClass)	Allows to use the Mustache language to pre-render a search definition.
<TDocument> SearchTemplateResponse<TDocument>	searchTemplate(SearchTemplateRequest request, java.lang.Class<TDocument> tDocumentClass)	Allows to use the Mustache language to pre-render a search definition.
OpenSearchShutdownClient	shutdown()
OpenSearchSnapshotClient	snapshot()
OpenSearchTasksClient	tasks()
TermsEnumResponse	termsEnum(java.util.function.Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)	The terms enum API can be used to discover terms in the index that begin with the provided string.
TermsEnumResponse	termsEnum(TermsEnumRequest request)	The terms enum API can be used to discover terms in the index that begin with the provided string.
<TDocument> TermvectorsResponse	termvectors(java.util.function.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.
<TDocument,TPartialDocument> UpdateResponse<TDocument>	update(java.util.function.Function<UpdateRequest.Builder<TDocument,TPartialDocument>,ObjectBuilder<UpdateRequest<TDocument,TPartialDocument>>> fn, java.lang.Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
<TDocument,TPartialDocument> UpdateResponse<TDocument>	update(UpdateRequest<TDocument,TPartialDocument> request, java.lang.Class<TDocument> tDocumentClass)	Updates a document with a script or partial document.
UpdateByQueryResponse	updateByQuery(java.util.function.Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
UpdateByQueryResponse	updateByQuery(UpdateByQueryRequest request)	Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
UpdateByQueryRethrottleResponse	updateByQueryRethrottle(java.util.function.Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)	Changes the number of requests per second for a particular Update By Query operation.
UpdateByQueryRethrottleResponse	updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)	Changes the number of requests per second for a particular Update By Query operation.
OpenSearchClient	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 Detail

OpenSearchClient

public OpenSearchClient(OpenSearchTransport transport)

OpenSearchClient

public OpenSearchClient(OpenSearchTransport transport,
                        @Nullable
                        TransportOptions transportOptions)

Method Detail

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>

cat

public OpenSearchCatClient cat()

cluster

public OpenSearchClusterClient cluster()

danglingIndices

public OpenSearchDanglingIndicesClient danglingIndices()

features

public OpenSearchFeaturesClient features()

indices

public OpenSearchIndicesClient indices()

ingest

public OpenSearchIngestClient ingest()

nodes

public OpenSearchNodesClient nodes()

shutdown

public OpenSearchShutdownClient shutdown()

snapshot

public OpenSearchSnapshotClient snapshot()

tasks

public OpenSearchTasksClient tasks()

bulk

public BulkResponse bulk(BulkRequest request)
                  throws java.io.IOException,
                         OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

bulk

public final BulkResponse bulk(java.util.function.Function<BulkRequest.Builder,ObjectBuilder<BulkRequest>> fn)
                        throws java.io.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:

java.io.IOException

OpenSearchException

bulk

public BulkResponse bulk()
                  throws java.io.IOException,
                         OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

clearScroll

public ClearScrollResponse clearScroll(ClearScrollRequest request)
                                throws java.io.IOException,
                                       OpenSearchException

Explicitly clears the search context for a scroll.

Throws:

java.io.IOException

OpenSearchException

clearScroll

public final ClearScrollResponse clearScroll(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)
                                      throws java.io.IOException,
                                             OpenSearchException

Explicitly clears the search context for a scroll.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

clearScroll

public ClearScrollResponse clearScroll()
                                throws java.io.IOException,
                                       OpenSearchException

Explicitly clears the search context for a scroll.

Throws:

java.io.IOException

OpenSearchException

count

public CountResponse count(CountRequest request)
                    throws java.io.IOException,
                           OpenSearchException

Returns number of documents matching a query.

Throws:

java.io.IOException

OpenSearchException

count

public final CountResponse count(java.util.function.Function<CountRequest.Builder,ObjectBuilder<CountRequest>> fn)
                          throws java.io.IOException,
                                 OpenSearchException

Returns number of documents matching a query.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

count

public CountResponse count()
                    throws java.io.IOException,
                           OpenSearchException

Returns number of documents matching a query.

Throws:

java.io.IOException

OpenSearchException

create

public <TDocument> CreateResponse create(CreateRequest<TDocument> request)
                                  throws java.io.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:

java.io.IOException

OpenSearchException

create

public final <TDocument> CreateResponse create(java.util.function.Function<CreateRequest.Builder<TDocument>,ObjectBuilder<CreateRequest<TDocument>>> fn)
                                        throws java.io.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:

java.io.IOException

OpenSearchException

createPit

public CreatePitResponse createPit(CreatePitRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.

Throws:

java.io.IOException

OpenSearchException

createPit

public final CreatePitResponse createPit(java.util.function.Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

Provides low-level information about the disk utilization of a PIT by describing its Lucene segments.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

delete

public DeleteResponse delete(DeleteRequest request)
                      throws java.io.IOException,
                             OpenSearchException

Removes a document from the index.

Throws:

java.io.IOException

OpenSearchException

delete

public final DeleteResponse delete(java.util.function.Function<DeleteRequest.Builder,ObjectBuilder<DeleteRequest>> fn)
                            throws java.io.IOException,
                                   OpenSearchException

Removes a document from the index.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deletePit

public DeletePitResponse deletePit(DeletePitRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Delete Point In Time

Throws:

java.io.IOException

OpenSearchException

deletePit

public final DeletePitResponse deletePit(java.util.function.Function<DeletePitRequest.Builder,ObjectBuilder<DeletePitRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

Delete Point In Time

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteByQuery

public DeleteByQueryResponse deleteByQuery(DeleteByQueryRequest request)
                                    throws java.io.IOException,
                                           OpenSearchException

Deletes documents matching the provided query.

Throws:

java.io.IOException

OpenSearchException

deleteByQuery

public final DeleteByQueryResponse deleteByQuery(java.util.function.Function<DeleteByQueryRequest.Builder,ObjectBuilder<DeleteByQueryRequest>> fn)
                                          throws java.io.IOException,
                                                 OpenSearchException

Deletes documents matching the provided query.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteByQueryRethrottle

public DeleteByQueryRethrottleResponse deleteByQueryRethrottle(DeleteByQueryRethrottleRequest request)
                                                        throws java.io.IOException,
                                                               OpenSearchException

Changes the number of requests per second for a particular Delete By Query operation.

Throws:

java.io.IOException

OpenSearchException

deleteByQueryRethrottle

public final DeleteByQueryRethrottleResponse deleteByQueryRethrottle(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,ObjectBuilder<DeleteByQueryRethrottleRequest>> fn)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Changes the number of requests per second for a particular Delete By Query operation.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteScript

public DeleteScriptResponse deleteScript(DeleteScriptRequest request)
                                  throws java.io.IOException,
                                         OpenSearchException

Deletes a script.

Throws:

java.io.IOException

OpenSearchException

deleteScript

public final DeleteScriptResponse deleteScript(java.util.function.Function<DeleteScriptRequest.Builder,ObjectBuilder<DeleteScriptRequest>> fn)
                                        throws java.io.IOException,
                                               OpenSearchException

Deletes a script.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

exists

public BooleanResponse exists(ExistsRequest request)
                       throws java.io.IOException,
                              OpenSearchException

Returns information about whether a document exists in an index.

Throws:

java.io.IOException

OpenSearchException

exists

public final BooleanResponse exists(java.util.function.Function<ExistsRequest.Builder,ObjectBuilder<ExistsRequest>> fn)
                             throws java.io.IOException,
                                    OpenSearchException

Returns information about whether a document exists in an index.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

existsSource

public BooleanResponse existsSource(ExistsSourceRequest request)
                             throws java.io.IOException,
                                    OpenSearchException

Returns information about whether a document source exists in an index.

Throws:

java.io.IOException

OpenSearchException

existsSource

public final BooleanResponse existsSource(java.util.function.Function<ExistsSourceRequest.Builder,ObjectBuilder<ExistsSourceRequest>> fn)
                                   throws java.io.IOException,
                                          OpenSearchException

Returns information about whether a document source exists in an index.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

explain

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

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

Throws:

java.io.IOException

OpenSearchException

explain

public final <TDocument> ExplainResponse<TDocument> explain(java.util.function.Function<ExplainRequest.Builder,ObjectBuilder<ExplainRequest>> fn,
                                                            java.lang.Class<TDocument> tDocumentClass)
                                                     throws java.io.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:

java.io.IOException

OpenSearchException

fieldCaps

public FieldCapsResponse fieldCaps(FieldCapsRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Returns the information about the capabilities of fields among multiple indices.

Throws:

java.io.IOException

OpenSearchException

fieldCaps

public final FieldCapsResponse fieldCaps(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

Returns the information about the capabilities of fields among multiple indices.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

fieldCaps

public FieldCapsResponse fieldCaps()
                            throws java.io.IOException,
                                   OpenSearchException

Returns the information about the capabilities of fields among multiple indices.

Throws:

java.io.IOException

OpenSearchException

get

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

Returns a document.

Throws:

java.io.IOException

OpenSearchException

get

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

Returns a document.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getScript

public GetScriptResponse getScript(GetScriptRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Returns a script.

Throws:

java.io.IOException

OpenSearchException

getScript

public final GetScriptResponse getScript(java.util.function.Function<GetScriptRequest.Builder,ObjectBuilder<GetScriptRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

Returns a script.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getScriptContext

public GetScriptContextResponse getScriptContext()
                                          throws java.io.IOException,
                                                 OpenSearchException

Returns all script contexts.

Throws:

java.io.IOException

OpenSearchException

getScriptLanguages

public GetScriptLanguagesResponse getScriptLanguages()
                                              throws java.io.IOException,
                                                     OpenSearchException

Returns available script types, languages and contexts

Throws:

java.io.IOException

OpenSearchException

getSource

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

Returns the source of a document.

Throws:

java.io.IOException

OpenSearchException

getSource

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

Returns the source of a document.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

index

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

Creates or updates a document in an index.

Throws:

java.io.IOException

OpenSearchException

index

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

Creates or updates a document in an index.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

info

public InfoResponse info()
                  throws java.io.IOException,
                         OpenSearchException

Returns basic information about the cluster.

Throws:

java.io.IOException

OpenSearchException

listAllPit

public ListAllPitResponse listAllPit()
                              throws java.io.IOException,
                                     OpenSearchException

List all Point In Time

Throws:

java.io.IOException

OpenSearchException

mget

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

Allows to get multiple documents in one request.

Throws:

java.io.IOException

OpenSearchException

mget

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

Allows to get multiple documents in one request.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

msearch

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

Allows to execute several search operations in one request.

Throws:

java.io.IOException

OpenSearchException

msearch

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

Allows to execute several search operations in one request.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

msearchTemplate

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

Allows to execute several search template operations in one request.

Throws:

java.io.IOException

OpenSearchException

msearchTemplate

public final <TDocument> MsearchTemplateResponse<TDocument> msearchTemplate(java.util.function.Function<MsearchTemplateRequest.Builder,ObjectBuilder<MsearchTemplateRequest>> fn,
                                                                            java.lang.Class<TDocument> tDocumentClass)
                                                                     throws java.io.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:

java.io.IOException

OpenSearchException

mtermvectors

public MtermvectorsResponse mtermvectors(MtermvectorsRequest request)
                                  throws java.io.IOException,
                                         OpenSearchException

Returns multiple termvectors in one request.

Throws:

java.io.IOException

OpenSearchException

mtermvectors

public final MtermvectorsResponse mtermvectors(java.util.function.Function<MtermvectorsRequest.Builder,ObjectBuilder<MtermvectorsRequest>> fn)
                                        throws java.io.IOException,
                                               OpenSearchException

Returns multiple termvectors in one request.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

mtermvectors

public MtermvectorsResponse mtermvectors()
                                  throws java.io.IOException,
                                         OpenSearchException

Returns multiple termvectors in one request.

Throws:

java.io.IOException

OpenSearchException

ping

public BooleanResponse ping()
                     throws java.io.IOException,
                            OpenSearchException

Returns whether the cluster is running.

Throws:

java.io.IOException

OpenSearchException

putScript

public PutScriptResponse putScript(PutScriptRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

Creates or updates a script.

Throws:

java.io.IOException

OpenSearchException

putScript

public final PutScriptResponse putScript(java.util.function.Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

Creates or updates a script.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

rankEval

public RankEvalResponse rankEval(RankEvalRequest request)
                          throws java.io.IOException,
                                 OpenSearchException

Allows to evaluate the quality of ranked search results over a set of typical search queries

Throws:

java.io.IOException

OpenSearchException

rankEval

public final RankEvalResponse rankEval(java.util.function.Function<RankEvalRequest.Builder,ObjectBuilder<RankEvalRequest>> fn)
                                throws java.io.IOException,
                                       OpenSearchException

Allows to evaluate the quality of ranked search results over a set of typical search queries

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

reindex

public ReindexResponse reindex(ReindexRequest request)
                        throws java.io.IOException,
                               OpenSearchException

Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

Throws:

java.io.IOException

OpenSearchException

reindex

public final ReindexResponse reindex(java.util.function.Function<ReindexRequest.Builder,ObjectBuilder<ReindexRequest>> fn)
                              throws java.io.IOException,
                                     OpenSearchException

Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

reindex

public ReindexResponse reindex()
                        throws java.io.IOException,
                               OpenSearchException

Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.

Throws:

java.io.IOException

OpenSearchException

reindexRethrottle

public ReindexRethrottleResponse reindexRethrottle(ReindexRethrottleRequest request)
                                            throws java.io.IOException,
                                                   OpenSearchException

Changes the number of requests per second for a particular Reindex operation.

Throws:

java.io.IOException

OpenSearchException

reindexRethrottle

public final ReindexRethrottleResponse reindexRethrottle(java.util.function.Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)
                                                  throws java.io.IOException,
                                                         OpenSearchException

Changes the number of requests per second for a particular Reindex operation.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate(RenderSearchTemplateRequest request)
                                                  throws java.io.IOException,
                                                         OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

renderSearchTemplate

public final RenderSearchTemplateResponse renderSearchTemplate(java.util.function.Function<RenderSearchTemplateRequest.Builder,ObjectBuilder<RenderSearchTemplateRequest>> fn)
                                                        throws java.io.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 RenderSearchTemplateRequest

Throws:

java.io.IOException

OpenSearchException

renderSearchTemplate

public RenderSearchTemplateResponse renderSearchTemplate()
                                                  throws java.io.IOException,
                                                         OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

scriptsPainlessExecute

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

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

Throws:

java.io.IOException

OpenSearchException

scriptsPainlessExecute

public final <TResult> ScriptsPainlessExecuteResponse<TResult> scriptsPainlessExecute(java.util.function.Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn,
                                                                                      java.lang.Class<TResult> tResultClass)
                                                                               throws java.io.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:

java.io.IOException

OpenSearchException

scroll

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

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

Throws:

java.io.IOException

OpenSearchException

scroll

public final <TDocument> ScrollResponse<TDocument> scroll(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn,
                                                          java.lang.Class<TDocument> tDocumentClass)
                                                   throws java.io.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:

java.io.IOException

OpenSearchException

search

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

Returns results matching a query.

Throws:

java.io.IOException

OpenSearchException

search

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

Returns results matching a query.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

searchShards

public SearchShardsResponse searchShards(SearchShardsRequest request)
                                  throws java.io.IOException,
                                         OpenSearchException

Returns information about the indices 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 indices 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 SearchShardsResponse searchShards()
                                  throws java.io.IOException,
                                         OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

searchTemplate

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

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

Throws:

java.io.IOException

OpenSearchException

searchTemplate

public final <TDocument> SearchTemplateResponse<TDocument> searchTemplate(java.util.function.Function<SearchTemplateRequest.Builder,ObjectBuilder<SearchTemplateRequest>> fn,
                                                                          java.lang.Class<TDocument> tDocumentClass)
                                                                   throws java.io.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:

java.io.IOException

OpenSearchException

termsEnum

public TermsEnumResponse termsEnum(TermsEnumRequest request)
                            throws java.io.IOException,
                                   OpenSearchException

The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

Throws:

java.io.IOException

OpenSearchException

termsEnum

public final TermsEnumResponse termsEnum(java.util.function.Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)
                                  throws java.io.IOException,
                                         OpenSearchException

The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

termvectors

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

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

Throws:

java.io.IOException

OpenSearchException

termvectors

public final <TDocument> TermvectorsResponse termvectors(java.util.function.Function<TermvectorsRequest.Builder<TDocument>,ObjectBuilder<TermvectorsRequest<TDocument>>> fn)
                                                  throws java.io.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:

java.io.IOException

OpenSearchException

update

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

Updates a document with a script or partial document.

Throws:

java.io.IOException

OpenSearchException

update

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

Updates a document with a script or partial document.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

updateByQuery

public UpdateByQueryResponse updateByQuery(UpdateByQueryRequest request)
                                    throws java.io.IOException,
                                           OpenSearchException

Performs an update on every document in the index without changing the source, for example to pick up a mapping change.

Throws:

java.io.IOException

OpenSearchException

updateByQuery

public final UpdateByQueryResponse updateByQuery(java.util.function.Function<UpdateByQueryRequest.Builder,ObjectBuilder<UpdateByQueryRequest>> fn)
                                          throws java.io.IOException,
                                                 OpenSearchException

Performs an update on every document in the index without changing the source, for example to pick up a mapping change.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

updateByQueryRethrottle

public UpdateByQueryRethrottleResponse updateByQueryRethrottle(UpdateByQueryRethrottleRequest request)
                                                        throws java.io.IOException,
                                                               OpenSearchException

Changes the number of requests per second for a particular Update By Query operation.

Throws:

java.io.IOException

OpenSearchException

updateByQueryRethrottle

public final UpdateByQueryRethrottleResponse updateByQueryRethrottle(java.util.function.Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)
                                                              throws java.io.IOException,
                                                                     OpenSearchException

Changes the number of requests per second for a particular Update By Query operation.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException