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

Class ProcessDefinitionInstanceVersionStatisticsRequestImpl

java.lang.Object

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

io.camunda.client.impl.statistics.request.ProcessDefinitionInstanceVersionStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<ProcessDefinitionInstanceVersionStatistics>>, FinalSearchRequestStep<ProcessDefinitionInstanceVersionStatistics>, TypedSortableRequest<ProcessDefinitionInstanceVersionStatisticsSort,ProcessDefinitionInstanceVersionStatisticsRequest>, ProcessDefinitionInstanceVersionStatisticsRequest, StatisticsRequest<ProcessDefinitionInstanceVersionStatisticsFilter,ProcessDefinitionInstanceVersionStatisticsRequest>

public class ProcessDefinitionInstanceVersionStatisticsRequestImpl
extends TypedSearchRequestPropertyProvider<ProcessDefinitionInstanceVersionStatisticsQuery>
implements ProcessDefinitionInstanceVersionStatisticsRequest

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.statistics.request.StatisticsRequest

StatisticsRequest.StatisticsRequestFilter

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
ProcessDefinitionInstanceVersionStatisticsRequestImpl(HttpClient httpClient, JsonMapper jsonMapper, String processDefinitionId)

Method Summary

Modifier and Type	Method	Description
ProcessDefinitionInstanceVersionStatisticsRequest	filter(ProcessDefinitionInstanceVersionStatisticsFilter value)	Sets the filter to be included in the statistics request.
ProcessDefinitionInstanceVersionStatisticsRequest	filter(Consumer<ProcessDefinitionInstanceVersionStatisticsFilter> fn)	Provides a fluent builder to create a filter to be included in the statistics request.
protected ProcessDefinitionInstanceVersionStatisticsQuery	getSearchRequestProperty()
ProcessDefinitionInstanceVersionStatisticsRequest	page(OffsetPage value)
ProcessDefinitionInstanceVersionStatisticsRequest	page(Consumer<OffsetPage> fn)
FinalSearchRequestStep<ProcessDefinitionInstanceVersionStatistics>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchResponse<ProcessDefinitionInstanceVersionStatistics>>	send()	Sends the command to the Camunda gateway.
ProcessDefinitionInstanceVersionStatisticsRequest	sort(ProcessDefinitionInstanceVersionStatisticsSort value)	Sets the sorting the returned entities should be sorted by.
ProcessDefinitionInstanceVersionStatisticsRequest	sort(Consumer<ProcessDefinitionInstanceVersionStatisticsSort> 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

ProcessDefinitionInstanceVersionStatisticsRequestImpl

public ProcessDefinitionInstanceVersionStatisticsRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 String processDefinitionId)

Method Details

requestTimeout

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

Specified by:

requestTimeout in interface FinalSearchRequestStep<ProcessDefinitionInstanceVersionStatistics>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

page

public ProcessDefinitionInstanceVersionStatisticsRequest page(OffsetPage value)

Specified by:

page in interface ProcessDefinitionInstanceVersionStatisticsRequest

page

public ProcessDefinitionInstanceVersionStatisticsRequest page(Consumer<OffsetPage> fn)

Specified by:

page in interface ProcessDefinitionInstanceVersionStatisticsRequest

filter

public ProcessDefinitionInstanceVersionStatisticsRequest filter(ProcessDefinitionInstanceVersionStatisticsFilter value)

Description copied from interface: StatisticsRequest

Sets the filter to be included in the statistics request.

Specified by:

filter in interface StatisticsRequest<ProcessDefinitionInstanceVersionStatisticsFilter,ProcessDefinitionInstanceVersionStatisticsRequest>

Parameters:

value - the filter

Returns:

the builder for the statistics request

filter

public ProcessDefinitionInstanceVersionStatisticsRequest filter(Consumer<ProcessDefinitionInstanceVersionStatisticsFilter> fn)

Description copied from interface: StatisticsRequest

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

Specified by:

filter in interface StatisticsRequest<ProcessDefinitionInstanceVersionStatisticsFilter,ProcessDefinitionInstanceVersionStatisticsRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the statistics request

sort

public ProcessDefinitionInstanceVersionStatisticsRequest sort(ProcessDefinitionInstanceVersionStatisticsSort value)

Description copied from interface: TypedSortableRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSortableRequest<ProcessDefinitionInstanceVersionStatisticsSort,ProcessDefinitionInstanceVersionStatisticsRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public ProcessDefinitionInstanceVersionStatisticsRequest sort(Consumer<ProcessDefinitionInstanceVersionStatisticsSort> 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<ProcessDefinitionInstanceVersionStatisticsSort,ProcessDefinitionInstanceVersionStatisticsRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

getSearchRequestProperty

protected ProcessDefinitionInstanceVersionStatisticsQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessDefinitionInstanceVersionStatisticsQuery>