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

Class HistoryCleanupApi

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

  • Constructor Details

    • HistoryCleanupApi

      public HistoryCleanupApi()

    • HistoryCleanupApi

      public HistoryCleanupApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • cleanupAsync

      public JobDto cleanupAsync(Boolean immediatelyDue) throws ApiException
      Clean up history (POST) Schedules asynchronous history cleanup (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). **Note:** This endpoint will return at most a single history cleanup job. Since version `7.9.0` it is possible to configure multiple [parallel history cleanup jobs](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#parallel-execution). Use [`GET /history/cleanup/jobs`](https://docs.camunda.org/manual/7.21/reference/rest/history/history-cleanup/get-history-cleanup-jobs) to find all the available history cleanup jobs.
      Parameters:
      immediatelyDue - When true the job will be scheduled for nearest future. When `false`, the job will be scheduled for next batch window start time. Default is `true`. (optional)
      Returns:
      JobDto
      Throws:
      ApiException - if fails to make API call

    • cleanupAsync

      public JobDto cleanupAsync(Boolean immediatelyDue, Map<String,String> additionalHeaders) throws ApiException
      Clean up history (POST) Schedules asynchronous history cleanup (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). **Note:** This endpoint will return at most a single history cleanup job. Since version `7.9.0` it is possible to configure multiple [parallel history cleanup jobs](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#parallel-execution). Use [`GET /history/cleanup/jobs`](https://docs.camunda.org/manual/7.21/reference/rest/history/history-cleanup/get-history-cleanup-jobs) to find all the available history cleanup jobs.
      Parameters:
      immediatelyDue - When true the job will be scheduled for nearest future. When `false`, the job will be scheduled for next batch window start time. Default is `true`. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JobDto
      Throws:
      ApiException - if fails to make API call

    • findCleanupJob

      @Deprecated public JobDto findCleanupJob() throws ApiException
      Deprecated.
      Find clean up history job (GET) **Deprecated!** Use `GET /history/cleanup/jobs` instead. Finds history cleanup job (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Returns:
      JobDto
      Throws:
      ApiException - if fails to make API call

    • findCleanupJob

      @Deprecated public JobDto findCleanupJob(Map<String,String> additionalHeaders) throws ApiException
      Deprecated.
      Find clean up history job (GET) **Deprecated!** Use `GET /history/cleanup/jobs` instead. Finds history cleanup job (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      JobDto
      Throws:
      ApiException - if fails to make API call

    • findCleanupJobs

      public List<JobDto> findCleanupJobs() throws ApiException
      Find clean up history jobs (GET) Finds history cleanup jobs (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Returns:
      List<JobDto>
      Throws:
      ApiException - if fails to make API call

    • findCleanupJobs

      public List<JobDto> findCleanupJobs(Map<String,String> additionalHeaders) throws ApiException
      Find clean up history jobs (GET) Finds history cleanup jobs (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JobDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoryCleanupConfiguration

      public HistoryCleanupConfigurationDto getHistoryCleanupConfiguration() throws ApiException
      Get History Cleanup Configuration Retrieves history cleanup batch window configuration (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Returns:
      HistoryCleanupConfigurationDto
      Throws:
      ApiException - if fails to make API call

    • getHistoryCleanupConfiguration

      public HistoryCleanupConfigurationDto getHistoryCleanupConfiguration(Map<String,String> additionalHeaders) throws ApiException
      Get History Cleanup Configuration Retrieves history cleanup batch window configuration (See [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)).
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoryCleanupConfigurationDto
      Throws:
      ApiException - if fails to make API call