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

Class IncidentsByProcessInstanceSearchRequestImpl

java.lang.Object

io.camunda.client.impl.search.request.IncidentsByProcessInstanceSearchRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<Incident>>, FinalSearchRequestStep<Incident>, IncidentsByProcessInstanceSearchRequest, TypedPageableRequest<IncidentsByProcessInstanceSearchRequest>, TypedSortableRequest<IncidentSort,IncidentsByProcessInstanceSearchRequest>

public class IncidentsByProcessInstanceSearchRequestImpl
extends Object
implements IncidentsByProcessInstanceSearchRequest

Nested Class Summary

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
IncidentsByProcessInstanceSearchRequestImpl(HttpClient httpClient, JsonMapper jsonMapper, long processInstanceKey)

Method Summary

Modifier and Type	Method	Description
IncidentsByProcessInstanceSearchRequest	page(SearchRequestPage value)	Support for pagination.
IncidentsByProcessInstanceSearchRequest	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
FinalSearchRequestStep<Incident>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchResponse<Incident>>	send()	Sends the command to the Camunda gateway.
IncidentsByProcessInstanceSearchRequest	sort(IncidentSort value)	Sets the sorting the returned entities should be sorted by.
IncidentsByProcessInstanceSearchRequest	sort(Consumer<IncidentSort> fn)	Provides a fluent builder to provide sorting options the returned entities should sorted by

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

IncidentsByProcessInstanceSearchRequestImpl

public IncidentsByProcessInstanceSearchRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 long processInstanceKey)

Method Details

requestTimeout

public FinalSearchRequestStep<Incident> 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<Incident>>

Specified by:

requestTimeout in interface FinalSearchRequestStep<Incident>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

sort

public IncidentsByProcessInstanceSearchRequest sort(IncidentSort value)

Description copied from interface: TypedSortableRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSortableRequest<IncidentSort,IncidentsByProcessInstanceSearchRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public IncidentsByProcessInstanceSearchRequest sort(Consumer<IncidentSort> 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<IncidentSort,IncidentsByProcessInstanceSearchRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

page

public IncidentsByProcessInstanceSearchRequest page(SearchRequestPage value)

Description copied from interface: TypedPageableRequest

Support for pagination.

Specified by:

page in interface TypedPageableRequest<IncidentsByProcessInstanceSearchRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public IncidentsByProcessInstanceSearchRequest page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedPageableRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedPageableRequest<IncidentsByProcessInstanceSearchRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request