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

Class JobErrorStatisticsRequestImpl

java.lang.Object

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

io.camunda.client.impl.statistics.request.JobErrorStatisticsRequestImpl

All Implemented Interfaces:

FinalCommandStep<JobErrorStatistics>, TypedFilterableRequest<JobErrorStatisticsFilter,JobErrorStatisticsRequest>, TypedPageableRequest<CursorForwardPage,JobErrorStatisticsRequest>, JobErrorStatisticsRequest

public class JobErrorStatisticsRequestImpl
extends TypedSearchRequestPropertyProvider<JobErrorStatisticsQuery>
implements JobErrorStatisticsRequest

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.search.request.TypedFilterableRequest

TypedFilterableRequest.SearchRequestFilter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
JobErrorStatisticsRequest	filter(JobErrorStatisticsFilter value)	Sets the filter to be included in the search request.
JobErrorStatisticsRequest	filter(Consumer<JobErrorStatisticsFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected JobErrorStatisticsQuery	getSearchRequestProperty()
JobErrorStatisticsRequest	page(CursorForwardPage value)	Support for pagination.
JobErrorStatisticsRequest	page(Consumer<CursorForwardPage> fn)	Provides a fluent builder to support pagination.
FinalCommandStep<JobErrorStatistics>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<JobErrorStatistics>	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

JobErrorStatisticsRequestImpl

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

Method Details

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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

getSearchRequestProperty

protected JobErrorStatisticsQuery getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<JobErrorStatisticsQuery>

filter

public JobErrorStatisticsRequest filter(JobErrorStatisticsFilter value)

Description copied from interface: TypedFilterableRequest

Sets the filter to be included in the search request. Invoking the method overrides previously set filters.

Specified by:

filter in interface TypedFilterableRequest<JobErrorStatisticsFilter,JobErrorStatisticsRequest>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public JobErrorStatisticsRequest filter(Consumer<JobErrorStatisticsFilter> fn)

Description copied from interface: TypedFilterableRequest

Provides a fluent builder to create a filter to be included in the search request. Invoking the method overrides previously set filters. You can chain multiple filter criteria inside the consumer you provide for such cases.

Specified by:

filter in interface TypedFilterableRequest<JobErrorStatisticsFilter,JobErrorStatisticsRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the search request

page

public JobErrorStatisticsRequest page(CursorForwardPage value)

Description copied from interface: TypedPageableRequest

Support for pagination.

Specified by:

page in interface TypedPageableRequest<CursorForwardPage,JobErrorStatisticsRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public JobErrorStatisticsRequest page(Consumer<CursorForwardPage> fn)

Description copied from interface: TypedPageableRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedPageableRequest<CursorForwardPage,JobErrorStatisticsRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request