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

Class JobTimeSeriesStatisticsRequestImpl

java.lang.Object

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

io.camunda.client.impl.statistics.request.JobTimeSeriesStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<JobTimeSeriesStatistics>, TypedPageableRequest<CursorForwardPage,JobTimeSeriesStatisticsRequest>, JobTimeSeriesStatisticsRequest

public class JobTimeSeriesStatisticsRequestImpl
extends TypedSearchRequestPropertyProvider<JobTimeSeriesStatisticsQuery>
implements JobTimeSeriesStatisticsRequest

Constructor Summary

Constructors

Constructor	Description
JobTimeSeriesStatisticsRequestImpl(HttpClient httpClient, JsonMapper jsonMapper, OffsetDateTime from, OffsetDateTime to, String jobType)

Method Summary

Modifier and Type	Method	Description
protected JobTimeSeriesStatisticsQuery	getSearchRequestProperty()
JobTimeSeriesStatisticsRequest	page(CursorForwardPage value)	Support for pagination.
JobTimeSeriesStatisticsRequest	page(Consumer<CursorForwardPage> fn)	Provides a fluent builder to support pagination.
FinalCommandStep<JobTimeSeriesStatistics>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
JobTimeSeriesStatisticsRequest	resolution(Duration resolution)	Sets the time bucket resolution.
CamundaFuture<JobTimeSeriesStatistics>	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

JobTimeSeriesStatisticsRequestImpl

public JobTimeSeriesStatisticsRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 OffsetDateTime from,
 OffsetDateTime to,
 String jobType)

Method Details

resolution

public JobTimeSeriesStatisticsRequest resolution(Duration resolution)

Description copied from interface: JobTimeSeriesStatisticsRequest

Sets the time bucket resolution. If not set the server will auto-compute a sensible default.

Specified by:

resolution in interface JobTimeSeriesStatisticsRequest

Parameters:

resolution - the desired bucket size (e.g. Duration.ofMinutes(1))

Returns:

this request builder

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

getSearchRequestProperty

protected JobTimeSeriesStatisticsQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<JobTimeSeriesStatisticsQuery>

page

public JobTimeSeriesStatisticsRequest page(CursorForwardPage value)

Description copied from interface: TypedPageableRequest

Support for pagination.

Specified by:

page in interface TypedPageableRequest<CursorForwardPage,JobTimeSeriesStatisticsRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public JobTimeSeriesStatisticsRequest page(Consumer<CursorForwardPage> fn)

Description copied from interface: TypedPageableRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedPageableRequest<CursorForwardPage,JobTimeSeriesStatisticsRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request