Package io.camunda.client.impl.statistics.request

Class ProcessDefinitionInstanceStatisticsRequestImpl

java.lang.Object

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

io.camunda.client.impl.statistics.request.ProcessDefinitionInstanceStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<ProcessDefinitionInstanceStatistics>>, FinalSearchRequestStep<ProcessDefinitionInstanceStatistics>, TypedSortableRequest<ProcessDefinitionInstanceStatisticsSort,ProcessDefinitionInstanceStatisticsRequest>, ProcessDefinitionInstanceStatisticsRequest

public class ProcessDefinitionInstanceStatisticsRequestImpl
extends TypedSearchRequestPropertyProvider<ProcessDefinitionInstanceStatisticsQuery>
implements ProcessDefinitionInstanceStatisticsRequest

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
ProcessDefinitionInstanceStatisticsRequestImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
protected ProcessDefinitionInstanceStatisticsQuery	getSearchRequestProperty()
ProcessDefinitionInstanceStatisticsRequest	page(OffsetPage value)
ProcessDefinitionInstanceStatisticsRequest	page(Consumer<OffsetPage> fn)
FinalSearchRequestStep<ProcessDefinitionInstanceStatistics>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchResponse<ProcessDefinitionInstanceStatistics>>	send()	Sends the command to the Camunda gateway.
ProcessDefinitionInstanceStatisticsRequest	sort(ProcessDefinitionInstanceStatisticsSort value)	Sets the sorting the returned entities should be sorted by.
ProcessDefinitionInstanceStatisticsRequest	sort(Consumer<ProcessDefinitionInstanceStatisticsSort> 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

ProcessDefinitionInstanceStatisticsRequestImpl

public ProcessDefinitionInstanceStatisticsRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

requestTimeout

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

Specified by:

requestTimeout in interface FinalSearchRequestStep<ProcessDefinitionInstanceStatistics>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

page

public ProcessDefinitionInstanceStatisticsRequest page(OffsetPage value)

Specified by:

page in interface ProcessDefinitionInstanceStatisticsRequest

page

public ProcessDefinitionInstanceStatisticsRequest page(Consumer<OffsetPage> fn)

Specified by:

page in interface ProcessDefinitionInstanceStatisticsRequest

sort

public ProcessDefinitionInstanceStatisticsRequest sort(ProcessDefinitionInstanceStatisticsSort value)

Description copied from interface: TypedSortableRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSortableRequest<ProcessDefinitionInstanceStatisticsSort,ProcessDefinitionInstanceStatisticsRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public ProcessDefinitionInstanceStatisticsRequest sort(Consumer<ProcessDefinitionInstanceStatisticsSort> 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<ProcessDefinitionInstanceStatisticsSort,ProcessDefinitionInstanceStatisticsRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

getSearchRequestProperty

protected ProcessDefinitionInstanceStatisticsQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessDefinitionInstanceStatisticsQuery>