Package org.openapitools.client.api

Class MetricsApi

  • public class MetricsApi
extends Object

    • Constructor Detail

      • MetricsApi

        public MetricsApi()

      • MetricsApi

        public MetricsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteTaskMetricsCall

        public okhttp3.Call deleteTaskMetricsCall​(Date date,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for deleteTaskMetrics
        Parameters:
        date - The date prior to which all task worker metrics should be deleted. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteTaskMetrics

        public void deleteTaskMetrics​(Date date)
                       throws ApiException
        Delete Task Worker Metrics Deletes all task worker metrics prior to the given date or all if no date is provided.
        Parameters:
        date - The date prior to which all task worker metrics should be deleted. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteTaskMetricsWithHttpInfo

        public ApiResponse<Void> deleteTaskMetricsWithHttpInfo​(Date date)
                                                throws ApiException
        Delete Task Worker Metrics Deletes all task worker metrics prior to the given date or all if no date is provided.
        Parameters:
        date - The date prior to which all task worker metrics should be deleted. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteTaskMetricsAsync

        public okhttp3.Call deleteTaskMetricsAsync​(Date date,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Delete Task Worker Metrics (asynchronously) Deletes all task worker metrics prior to the given date or all if no date is provided.
        Parameters:
        date - The date prior to which all task worker metrics should be deleted. (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

      • 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
        Get Sum 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
        Get Sum 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
        Get Sum (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.18/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
        Get Metrics in Interval 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.18/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
        Get Metrics in Interval 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.18/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
        Get Metrics in Interval (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.18/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