Package io.camunda.client.impl.search.request

Class ProcessInstanceSearchRequestImpl

java.lang.Object

io.camunda.client.impl.search.request.TypedSearchRequestPropertyProvider<ProcessInstanceSearchQuery>

io.camunda.client.impl.search.request.ProcessInstanceSearchRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<ProcessInstance>>, FinalSearchRequestStep<ProcessInstance>, ProcessInstanceSearchRequest, TypedFilterableRequest<ProcessInstanceFilter,ProcessInstanceSearchRequest>, TypedPageableRequest<ProcessInstanceSearchRequest>, TypedSearchRequest<ProcessInstanceFilter,ProcessInstanceSort,ProcessInstanceSearchRequest>, TypedSortableRequest<ProcessInstanceSort,ProcessInstanceSearchRequest>

public class ProcessInstanceSearchRequestImpl
extends TypedSearchRequestPropertyProvider<ProcessInstanceSearchQuery>
implements ProcessInstanceSearchRequest

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.search.request.TypedFilterableRequest

TypedFilterableRequest.SearchRequestFilter

Nested classes/interfaces inherited from interface io.camunda.client.api.search.request.TypedSortableRequest

TypedSortableRequest.SearchRequestSort<S extends TypedSortableRequest.SearchRequestSort<S>>

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceSearchRequestImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
ProcessInstanceSearchRequest	filter(ProcessInstanceFilter value)	Sets the filter to be included in the search request.
ProcessInstanceSearchRequest	filter(Consumer<ProcessInstanceFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected ProcessInstanceSearchQuery	getSearchRequestProperty()
ProcessInstanceSearchRequest	page(SearchRequestPage value)	Support for pagination.
ProcessInstanceSearchRequest	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
FinalSearchRequestStep<ProcessInstance>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchResponse<ProcessInstance>>	send()	Sends the command to the Camunda gateway.
ProcessInstanceSearchRequest	sort(ProcessInstanceSort value)	Sets the sorting the returned entities should be sorted by.
ProcessInstanceSearchRequest	sort(Consumer<ProcessInstanceSort> fn)	Provides a fluent builder to provide sorting options the returned entities should sorted by

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

provideSearchRequestProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

ProcessInstanceSearchRequestImpl

public ProcessInstanceSearchRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

requestTimeout

public FinalSearchRequestStep<ProcessInstance> 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<SearchResponse<ProcessInstance>>

Specified by:

requestTimeout in interface FinalSearchRequestStep<ProcessInstance>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<SearchResponse<ProcessInstance>> 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<SearchResponse<ProcessInstance>>

Returns:

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

filter

public ProcessInstanceSearchRequest filter(ProcessInstanceFilter value)

Description copied from interface: TypedFilterableRequest

Sets the filter to be included in the search request. Invoking the method overrides previously set filters.

Specified by:

filter in interface TypedFilterableRequest<ProcessInstanceFilter,ProcessInstanceSearchRequest>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public ProcessInstanceSearchRequest filter(Consumer<ProcessInstanceFilter> fn)

Description copied from interface: TypedFilterableRequest

Provides a fluent builder to create a filter to be included in the search request. Invoking the method overrides previously set filters. You can chain multiple filter criteria inside the consumer you provide for such cases.

Specified by:

filter in interface TypedFilterableRequest<ProcessInstanceFilter,ProcessInstanceSearchRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the search request

sort

public ProcessInstanceSearchRequest sort(ProcessInstanceSort value)

Description copied from interface: TypedSortableRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSortableRequest<ProcessInstanceSort,ProcessInstanceSearchRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public ProcessInstanceSearchRequest sort(Consumer<ProcessInstanceSort> fn)

Description copied from interface: TypedSortableRequest

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

Specified by:

sort in interface TypedSortableRequest<ProcessInstanceSort,ProcessInstanceSearchRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

page

public ProcessInstanceSearchRequest page(SearchRequestPage value)

Description copied from interface: TypedPageableRequest

Support for pagination.

Specified by:

page in interface TypedPageableRequest<ProcessInstanceSearchRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public ProcessInstanceSearchRequest page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedPageableRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedPageableRequest<ProcessInstanceSearchRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request

getSearchRequestProperty

protected ProcessInstanceSearchQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessInstanceSearchQuery>