Package org.camunda.community.rest.client.api

Class MetricsApi

java.lang.Object
org.camunda.community.rest.client.api.MetricsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class MetricsApi extends Object

  • Constructor Details

    • MetricsApi

      public MetricsApi()

    • MetricsApi

      public MetricsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteTaskMetrics

      public void deleteTaskMetrics(OffsetDateTime 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 fails to make API call

    • deleteTaskMetrics

      public void deleteTaskMetrics(OffsetDateTime date, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getMetrics

      public MetricsResultDto getMetrics(String metricsName, OffsetDateTime startDate, OffsetDateTime 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 fails to make API call

    • getMetrics

      public MetricsResultDto getMetrics(String metricsName, OffsetDateTime startDate, OffsetDateTime endDate, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      MetricsResultDto
      Throws:
      ApiException - if fails to make API call

    • interval

      public List<MetricsIntervalResultDto> interval(String name, String reporter, OffsetDateTime startDate, OffsetDateTime 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.21/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 fails to make API call

    • interval

      public List<MetricsIntervalResultDto> interval(String name, String reporter, OffsetDateTime startDate, OffsetDateTime endDate, Integer firstResult, Integer maxResults, String interval, String aggregateByReporter, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<MetricsIntervalResultDto>
      Throws:
      ApiException - if fails to make API call