Package io.camunda.search.clients

Class SearchClientBasedQueryExecutor

java.lang.Object
io.camunda.search.clients.SearchClientBasedQueryExecutor
All Implemented Interfaces:
io.camunda.zeebe.util.CloseableSilently, AutoCloseable
public final class SearchClientBasedQueryExecutor extends Object implements io.camunda.zeebe.util.CloseableSilently

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchClientBasedQueryExecutor(DocumentBasedSearchClient searchClient, ServiceTransformers transformers)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, R extends io.camunda.search.aggregation.result.AggregationResultBase>
    R
    aggregate(io.camunda.search.query.TypedSearchQuery<F,S> query, Class<R> resultClass, io.camunda.security.reader.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, io.camunda.search.result.QueryResultConfig config)
    Returns a single document by id *
    <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, T, R>
    R
    getByQuery(io.camunda.search.query.TypedSearchQuery<F,S> query, Class<T> documentClass)
    Gets a single document (or null) by query.
    <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, T, R>
    io.camunda.search.query.SearchQueryResult<R>
    search(io.camunda.search.query.TypedSearchQuery<F,S> query, Class<T> documentClass, io.camunda.security.reader.ResourceAccessChecks resourceAccessChecks)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • search

      public <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, T, R> io.camunda.search.query.SearchQueryResult<R> search(io.camunda.search.query.TypedSearchQuery<F,S> query, Class<T> documentClass, io.camunda.security.reader.ResourceAccessChecks resourceAccessChecks)

    • aggregate

      public <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, R extends io.camunda.search.aggregation.result.AggregationResultBase> R aggregate(io.camunda.search.query.TypedSearchQuery<F,S> query, Class<R> resultClass, io.camunda.security.reader.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, io.camunda.search.result.QueryResultConfig config)
      Returns a single document by id *

    • getByQuery

      public <F extends io.camunda.search.filter.FilterBase, S extends io.camunda.search.sort.SortOption, T, R> R getByQuery(io.camunda.search.query.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 io.camunda.zeebe.util.CloseableSilently