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

Class ProcessDefinitionElementStatisticsRequestImpl

java.lang.Object

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

io.camunda.client.impl.statistics.request.ProcessDefinitionElementStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<List<ProcessElementStatistics>>, ProcessDefinitionElementStatisticsRequest, StatisticsRequest<ProcessDefinitionStatisticsFilter,ProcessDefinitionElementStatisticsRequest>

public class ProcessDefinitionElementStatisticsRequestImpl
extends TypedSearchRequestPropertyProvider<ProcessDefinitionElementStatisticsQuery>
implements ProcessDefinitionElementStatisticsRequest

Nested Class Summary

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

StatisticsRequest.StatisticsRequestFilter

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitionElementStatisticsRequestImpl(HttpClient httpClient, JsonMapper jsonMapper, long processDefinitionKey)

Method Summary

Modifier and Type	Method	Description
ProcessDefinitionElementStatisticsRequest	filter(ProcessDefinitionStatisticsFilter value)	Sets the filter to be included in the statistics request.
ProcessDefinitionElementStatisticsRequest	filter(Consumer<ProcessDefinitionStatisticsFilter> fn)	Provides a fluent builder to create a filter to be included in the statistics request.
protected ProcessDefinitionElementStatisticsQuery	getSearchRequestProperty()
FinalCommandStep<List<ProcessElementStatistics>>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<List<ProcessElementStatistics>>	send()	Sends the command to the Camunda gateway.

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

ProcessDefinitionElementStatisticsRequestImpl

public ProcessDefinitionElementStatisticsRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 long processDefinitionKey)

Method Details

requestTimeout

public FinalCommandStep<List<ProcessElementStatistics>> 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<List<ProcessElementStatistics>>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<List<ProcessElementStatistics>> 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<List<ProcessElementStatistics>>

Returns:

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

filter

public ProcessDefinitionElementStatisticsRequest filter(ProcessDefinitionStatisticsFilter value)

Description copied from interface: StatisticsRequest

Sets the filter to be included in the statistics request.

Specified by:

filter in interface StatisticsRequest<ProcessDefinitionStatisticsFilter,ProcessDefinitionElementStatisticsRequest>

Parameters:

value - the filter

Returns:

the builder for the statistics request

filter

public ProcessDefinitionElementStatisticsRequest filter(Consumer<ProcessDefinitionStatisticsFilter> 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<ProcessDefinitionStatisticsFilter,ProcessDefinitionElementStatisticsRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the statistics request

getSearchRequestProperty

protected ProcessDefinitionElementStatisticsQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessDefinitionElementStatisticsQuery>