public class MetricsApi extends Object
Constructor and Description |
---|
MetricsApi() |
MetricsApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
void |
deleteTaskMetrics(Date date)
Delete Task Worker Metrics
Deletes all task worker metrics prior to the given date or all if no date is provided.
|
okhttp3.Call |
deleteTaskMetricsAsync(Date date,
ApiCallback<Void> _callback)
Delete Task Worker Metrics (asynchronously)
Deletes all task worker metrics prior to the given date or all if no date is provided.
|
okhttp3.Call |
deleteTaskMetricsCall(Date date,
ApiCallback _callback)
Build call for deleteTaskMetrics
|
ApiResponse<Void> |
deleteTaskMetricsWithHttpInfo(Date date)
Delete Task Worker Metrics
Deletes all task worker metrics prior to the given date or all if no date is provided.
|
ApiClient |
getApiClient() |
MetricsResultDto |
getMetrics(String metricsName,
Date startDate,
Date endDate)
Get Sum
Retrieves the `sum` (count) for a given metric.
|
okhttp3.Call |
getMetricsAsync(String metricsName,
Date startDate,
Date endDate,
ApiCallback<MetricsResultDto> _callback)
Get Sum (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)
Get Sum
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)
Get Metrics in Interval
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)
Get Metrics in Interval (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)
Get Metrics in Interval
Retrieves a list of metrics, aggregated for a given interval.
|
void |
setApiClient(ApiClient apiClient) |
public MetricsApi()
public MetricsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call deleteTaskMetricsCall(Date date, ApiCallback _callback) throws ApiException
date
- The date prior to which all task worker metrics should be deleted. (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic void deleteTaskMetrics(Date date) throws ApiException
date
- The date prior to which all task worker metrics should be deleted. (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteTaskMetricsWithHttpInfo(Date date) throws ApiException
date
- The date prior to which all task worker metrics should be deleted. (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteTaskMetricsAsync(Date date, ApiCallback<Void> _callback) throws ApiException
date
- The date prior to which all task worker metrics should be deleted. (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getMetricsCall(String metricsName, Date startDate, Date endDate, ApiCallback _callback) throws ApiException
metricsName
- The name of the metric. (required)startDate
- The start date (inclusive). (optional)endDate
- The end date (exclusive). (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic MetricsResultDto getMetrics(String metricsName, Date startDate, Date endDate) throws ApiException
metricsName
- The name of the metric. (required)startDate
- The start date (inclusive). (optional)endDate
- The end date (exclusive). (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<MetricsResultDto> getMetricsWithHttpInfo(String metricsName, Date startDate, Date endDate) throws ApiException
metricsName
- The name of the metric. (required)startDate
- The start date (inclusive). (optional)endDate
- The end date (exclusive). (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getMetricsAsync(String metricsName, Date startDate, Date endDate, ApiCallback<MetricsResultDto> _callback) throws ApiException
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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call intervalCall(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter, ApiCallback _callback) throws ApiException
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.15/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 progressApiException
- If fail to serialize the request body objectpublic List<MetricsIntervalResultDto> interval(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter) throws ApiException
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.15/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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<MetricsIntervalResultDto>> intervalWithHttpInfo(String name, String reporter, Date startDate, Date endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter) throws ApiException
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.15/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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic 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
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.15/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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectCopyright © 2022. All rights reserved.