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

Class GlobalJobStatisticsRequestImpl

java.lang.Object

io.camunda.client.impl.statistics.request.GlobalJobStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<GlobalJobStatistics>, GlobalJobStatisticsRequest

public class GlobalJobStatisticsRequestImpl
extends Object
implements GlobalJobStatisticsRequest

Constructor Summary

Constructors

Constructor	Description
GlobalJobStatisticsRequestImpl(HttpClient httpClient, OffsetDateTime from, OffsetDateTime to)

Method Summary

Modifier and Type	Method	Description
GlobalJobStatisticsRequest	jobType(String jobType)	Filters statistics to only include jobs of the given type.
FinalCommandStep<GlobalJobStatistics>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<GlobalJobStatistics>	send()	Sends the command to the Camunda gateway.

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

GlobalJobStatisticsRequestImpl

public GlobalJobStatisticsRequestImpl(HttpClient httpClient,
 OffsetDateTime from,
 OffsetDateTime to)

Method Details

requestTimeout

public FinalCommandStep<GlobalJobStatistics> 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<GlobalJobStatistics>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<GlobalJobStatistics> 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<GlobalJobStatistics>

Returns:

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

jobType

public GlobalJobStatisticsRequest jobType(String jobType)

Description copied from interface: GlobalJobStatisticsRequest

Filters statistics to only include jobs of the given type.

Specified by:

jobType in interface GlobalJobStatisticsRequest

Parameters:

jobType - the job type to filter by

Returns:

this request builder