Package io.camunda.search.clients

Class SearchClientBasedQueryExecutor

java.lang.Object

io.camunda.search.clients.SearchClientBasedQueryExecutor

All Implemented Interfaces:

CloseableSilently, AutoCloseable

public final class SearchClientBasedQueryExecutor
extends Object
implements CloseableSilently

Constructor Summary

Constructors

Constructor	Description
SearchClientBasedQueryExecutor(DocumentBasedSearchClient searchClient, ServiceTransformers transformers)

Method Summary

Modifier and Type	Method	Description
<F extends FilterBase, S extends SortOption, R extends AggregationResultBase> R	aggregate(TypedSearchQuery<F,S> query, Class<R> resultClass, ResourceAccessChecks resourceAccessChecks)
void	close()
<T, R> R	getById(String id, Class<T> documentClass, String index)	Returns a single document by id *
<T, R> R	getById(String id, Class<T> documentClass, String index, QueryResultConfig config)	Returns a single document by id *
<F extends FilterBase, S extends SortOption, T, R> R	getByQuery(TypedSearchQuery<F,S> query, Class<T> documentClass)	Gets a single document (or null) by query.
<F extends FilterBase, S extends SortOption, T, R> SearchQueryResult<R>	search(TypedSearchQuery<F,S> query, Class<T> documentClass, ResourceAccessChecks resourceAccessChecks)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchClientBasedQueryExecutor

public SearchClientBasedQueryExecutor(DocumentBasedSearchClient searchClient,
 ServiceTransformers transformers)

Method Details

search

public <F extends FilterBase,
S extends SortOption,
T,
R>
SearchQueryResult<R> search(TypedSearchQuery<F,S> query,
 Class<T> documentClass,
 ResourceAccessChecks resourceAccessChecks)

aggregate

public <F extends FilterBase,
S extends SortOption,
R extends AggregationResultBase>
R aggregate(TypedSearchQuery<F,S> query,
 Class<R> resultClass,
 ResourceAccessChecks resourceAccessChecks)

getById

public <T,
R> R getById(String id,
 Class<T> documentClass,
 String index)

Returns a single document by id *

getById

public <T,
R> R getById(String id,
 Class<T> documentClass,
 String index,
 QueryResultConfig config)

Returns a single document by id *

getByQuery

public <F extends FilterBase,
S extends SortOption,
T,
R>
R getByQuery(TypedSearchQuery<F,S> query,
 Class<T> documentClass)

Gets a single document (or null) by query. Throws an exception if the query returns more than one document.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableSilently