org.openapitools.client.api

Class MetricsApi

java.lang.Object

org.openapitools.client.api.MetricsApi

public class MetricsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MetricsApi()
MetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
MetricsResultDto	getMetrics(String metricsName, Date startDate, Date endDate) Retrieves the `sum` (count) for a given metric.
okhttp3.Call	getMetricsAsync(String metricsName, Date startDate, Date endDate, ApiCallback<MetricsResultDto> _callback) (asynchronously) Retrieves the `sum` (count) for a given metric.
okhttp3.Call	getMetricsCall(String metricsName, Date startDate, Date endDate, ApiCallback _callback) Build call for getMetrics
ApiResponse<MetricsResultDto>	getMetricsWithHttpInfo(String metricsName, Date startDate, Date endDate) Retrieves the `sum` (count) for a given metric.
List<MetricsIntervalResultDto>	interval(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter) Retrieves a list of metrics, aggregated for a given interval.
okhttp3.Call	intervalAsync(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter, ApiCallback<List<MetricsIntervalResultDto>> _callback) (asynchronously) Retrieves a list of metrics, aggregated for a given interval.
okhttp3.Call	intervalCall(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter, ApiCallback _callback) Build call for interval
ApiResponse<List<MetricsIntervalResultDto>>	intervalWithHttpInfo(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter) Retrieves a list of metrics, aggregated for a given interval.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsApi

public MetricsApi()

MetricsApi

public MetricsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getMetricsCall

public okhttp3.Call getMetricsCall(String metricsName,
                                   Date startDate,
                                   Date endDate,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getMetrics

Parameters:

metricsName - The name of the metric. (required)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMetrics

public MetricsResultDto getMetrics(String metricsName,
                                   Date startDate,
                                   Date endDate)
                            throws ApiException

Retrieves the `sum` (count) for a given metric.

Parameters:

metricsName - The name of the metric. (required)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

Returns:

MetricsResultDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetricsWithHttpInfo

public ApiResponse<MetricsResultDto> getMetricsWithHttpInfo(String metricsName,
                                                            Date startDate,
                                                            Date endDate)
                                                     throws ApiException

Retrieves the `sum` (count) for a given metric.

Parameters:

metricsName - The name of the metric. (required)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

Returns:

ApiResponse<MetricsResultDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetricsAsync

public okhttp3.Call getMetricsAsync(String metricsName,
                                    Date startDate,
                                    Date endDate,
                                    ApiCallback<MetricsResultDto> _callback)
                             throws ApiException

(asynchronously) Retrieves the `sum` (count) for a given metric.

Parameters:

metricsName - The name of the metric. (required)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

intervalCall

public okhttp3.Call intervalCall(String name,
                                 String reporter,
                                 Date startDate,
                                 Date endDate,
                                 Integer firstResult,
                                 Integer maxResults,
                                 String interval,
                                 String aggregateByReporter,
                                 ApiCallback _callback)
                          throws ApiException

Build call for interval

Parameters:

name - The name of the metric. (optional)

reporter - The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.13/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

interval - The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")

aggregateByReporter - Aggregate metrics by reporter. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

interval

public List<MetricsIntervalResultDto> interval(String name,
                                               String reporter,
                                               Date startDate,
                                               Date endDate,
                                               Integer firstResult,
                                               Integer maxResults,
                                               String interval,
                                               String aggregateByReporter)
                                        throws ApiException

Retrieves a list of metrics, aggregated for a given interval.

Parameters:

name - The name of the metric. (optional)

reporter - The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.13/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

interval - The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")

aggregateByReporter - Aggregate metrics by reporter. (optional)

Returns:

List<MetricsIntervalResultDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

intervalWithHttpInfo

public ApiResponse<List<MetricsIntervalResultDto>> intervalWithHttpInfo(String name,
                                                                        String reporter,
                                                                        Date startDate,
                                                                        Date endDate,
                                                                        Integer firstResult,
                                                                        Integer maxResults,
                                                                        String interval,
                                                                        String aggregateByReporter)
                                                                 throws ApiException

Retrieves a list of metrics, aggregated for a given interval.

Parameters:

name - The name of the metric. (optional)

reporter - The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.13/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

interval - The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")

aggregateByReporter - Aggregate metrics by reporter. (optional)

Returns:

ApiResponse<List<MetricsIntervalResultDto>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

intervalAsync

public okhttp3.Call intervalAsync(String name,
                                  String reporter,
                                  Date startDate,
                                  Date endDate,
                                  Integer firstResult,
                                  Integer maxResults,
                                  String interval,
                                  String aggregateByReporter,
                                  ApiCallback<List<MetricsIntervalResultDto>> _callback)
                           throws ApiException

(asynchronously) Retrieves a list of metrics, aggregated for a given interval.

Parameters:

name - The name of the metric. (optional)

reporter - The name of the reporter (host), on which the metrics was logged. This will have value provided by the [hostname configuration property](https://docs.camunda.org/manual/7.13/reference/deployment-descriptors/tags/process-engine/#hostname). (optional)

startDate - The start date (inclusive). (optional)

endDate - The end date (exclusive). (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

interval - The interval for which the metrics should be aggregated. Time unit is seconds. Default: The interval is set to 15 minutes (900 seconds). (optional, default to "900")

aggregateByReporter - Aggregate metrics by reporter. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object