Package io.camunda.client.impl.search.query

Class DecisionInstanceQueryImpl

java.lang.Object

io.camunda.client.impl.search.TypedSearchRequestPropertyProvider<DecisionInstanceSearchQuery>

io.camunda.client.impl.search.query.DecisionInstanceQueryImpl

All Implemented Interfaces:

FinalCommandStep<SearchQueryResponse<DecisionInstance>>, DecisionInstanceQuery, FinalSearchQueryStep<DecisionInstance>, TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

public class DecisionInstanceQueryImpl
extends TypedSearchRequestPropertyProvider<DecisionInstanceSearchQuery>
implements DecisionInstanceQuery

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.search.query.TypedSearchQueryRequest

TypedSearchQueryRequest.SearchRequestFilter, TypedSearchQueryRequest.SearchRequestSort<S extends TypedSearchQueryRequest.SearchRequestSort<S>>

Constructor Summary

Constructors

Constructor	Description
DecisionInstanceQueryImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
DecisionInstanceQuery	filter(DecisionInstanceFilter value)	Sets the filter to be included in the search request.
DecisionInstanceQuery	filter(Consumer<DecisionInstanceFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected DecisionInstanceSearchQuery	getSearchRequestProperty()
DecisionInstanceQuery	page(SearchRequestPage value)	Support for pagination.
DecisionInstanceQuery	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
FinalSearchQueryStep<DecisionInstance>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchQueryResponse<DecisionInstance>>	send()	Sends the command to the Camunda gateway.
DecisionInstanceQuery	sort(DecisionInstanceSort value)	Sets the sorting the returned entities should be sorted by.
DecisionInstanceQuery	sort(Consumer<DecisionInstanceSort> fn)	Provides a fluent builder to provide sorting options the returned entites should sorted by

Methods inherited from class io.camunda.client.impl.search.TypedSearchRequestPropertyProvider

provideSearchRequestProperty

Methods inherited from class java.lang.Object

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

Constructor Details

DecisionInstanceQueryImpl

public DecisionInstanceQueryImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

filter

public DecisionInstanceQuery filter(DecisionInstanceFilter value)

Description copied from interface: TypedSearchQueryRequest

Sets the filter to be included in the search request.

Specified by:

filter in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public DecisionInstanceQuery filter(Consumer<DecisionInstanceFilter> fn)

Description copied from interface: TypedSearchQueryRequest

Provides a fluent builder to create a filter to be included in the search request.

Specified by:

filter in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Returns:

the builder for the search request

sort

public DecisionInstanceQuery sort(DecisionInstanceSort value)

Description copied from interface: TypedSearchQueryRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public DecisionInstanceQuery sort(Consumer<DecisionInstanceSort> fn)

Description copied from interface: TypedSearchQueryRequest

Provides a fluent builder to provide sorting options the returned entites should sorted by

Specified by:

sort in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Returns:

the builder for the search request

page

public DecisionInstanceQuery page(SearchRequestPage value)

Description copied from interface: TypedSearchQueryRequest

Support for pagination.

Specified by:

page in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public DecisionInstanceQuery page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedSearchQueryRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedSearchQueryRequest<DecisionInstanceFilter,DecisionInstanceSort,DecisionInstanceQuery>

Returns:

the builder for the search request

getSearchRequestProperty

protected DecisionInstanceSearchQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<DecisionInstanceSearchQuery>

requestTimeout

public FinalSearchQueryStep<DecisionInstance> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<SearchQueryResponse<DecisionInstance>>

Specified by:

requestTimeout in interface FinalSearchQueryStep<DecisionInstance>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<SearchQueryResponse<DecisionInstance>> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<SearchQueryResponse<DecisionInstance>>

Returns:

a future tracking state of success/failure of the command.