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

Class ProcessInstanceQueryImpl

java.lang.Object

io.camunda.zeebe.client.impl.search.TypedSearchRequestPropertyProvider<ProcessInstanceSearchQueryRequest>

io.camunda.zeebe.client.impl.search.query.ProcessInstanceQueryImpl

All Implemented Interfaces:

FinalCommandStep<SearchQueryResponse<ProcessInstance>>, FinalSearchQueryStep<ProcessInstance>, ProcessInstanceQuery, TypedSearchQueryRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

public class ProcessInstanceQueryImpl
extends TypedSearchRequestPropertyProvider<ProcessInstanceSearchQueryRequest>
implements ProcessInstanceQuery

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceQueryImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
ProcessInstanceQuery	filter(ProcessInstanceFilter value)	Sets the filter to be included in the search request.
ProcessInstanceQuery	filter(Consumer<ProcessInstanceFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected ProcessInstanceSearchQueryRequest	getSearchRequestProperty()
ProcessInstanceQuery	page(SearchRequestPage value)	Support for pagination.
ProcessInstanceQuery	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
FinalSearchQueryStep<ProcessInstance>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<SearchQueryResponse<ProcessInstance>>	send()	Sends the command to the Zeebe broker.
ProcessInstanceQuery	sort(ProcessInstanceSort value)	Sets the sorting the returned entities should be sorted by.
ProcessInstanceQuery	sort(Consumer<ProcessInstanceSort> fn)	Provides a fluent builder to provide sorting options the returned entites should sorted by

Methods inherited from class io.camunda.zeebe.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

ProcessInstanceQueryImpl

public ProcessInstanceQueryImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

requestTimeout

public FinalSearchQueryStep<ProcessInstance> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

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

Specified by:

requestTimeout in interface FinalCommandStep<SearchQueryResponse<ProcessInstance>>

Specified by:

requestTimeout in interface FinalSearchQueryStep<ProcessInstance>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<SearchQueryResponse<ProcessInstance>> send()

Description copied from interface: FinalCommandStep

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

Call ZeebeFuture.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<ProcessInstance>>

Returns:

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

filter

public ProcessInstanceQuery filter(ProcessInstanceFilter value)

Description copied from interface: TypedSearchQueryRequest

Sets the filter to be included in the search request.

Specified by:

filter in interface TypedSearchQueryRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public ProcessInstanceQuery filter(Consumer<ProcessInstanceFilter> 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<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Returns:

the builder for the search request

sort

public ProcessInstanceQuery sort(ProcessInstanceSort value)

Description copied from interface: TypedSearchQueryRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSearchQueryRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public ProcessInstanceQuery sort(Consumer<ProcessInstanceSort> 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<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Returns:

the builder for the search request

page

public ProcessInstanceQuery page(SearchRequestPage value)

Description copied from interface: TypedSearchQueryRequest

Support for pagination.

Specified by:

page in interface TypedSearchQueryRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public ProcessInstanceQuery page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedSearchQueryRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedSearchQueryRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceQuery>

Returns:

the builder for the search request

getSearchRequestProperty

protected ProcessInstanceSearchQueryRequest getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessInstanceSearchQueryRequest>