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

Class HistoricJobLogApi

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

  • Constructor Details

    • HistoricJobLogApi

      public HistoricJobLogApi()

    • HistoricJobLogApi

      public HistoricJobLogApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHistoricJobLog

      public HistoricJobLogDto getHistoricJobLog(String id) throws ApiException
      Get Job Log Retrieves a historic job log by id.
      Parameters:
      id - The id of the log entry. (required)
      Returns:
      HistoricJobLogDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricJobLog

      public HistoricJobLogDto getHistoricJobLog(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Job Log Retrieves a historic job log by id.
      Parameters:
      id - The id of the log entry. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricJobLogDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricJobLogs

      public List<HistoricJobLogDto> getHistoricJobLogs(String logId, String jobId, String jobExceptionMessage, String jobDefinitionId, String jobDefinitionType, String jobDefinitionConfiguration, String activityIdIn, String failedActivityIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String deploymentId, String tenantIdIn, Boolean withoutTenantId, String hostname, Long jobPriorityLowerThanOrEquals, Long jobPriorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Job Logs Queries for historic job logs that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Job Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query-count/) method.
      Parameters:
      logId - Filter by historic job log id. (optional)
      jobId - Filter by job id. (optional)
      jobExceptionMessage - Filter by job exception message. (optional)
      jobDefinitionId - Filter by job definition id. (optional)
      jobDefinitionType - Filter by job definition type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/the-job-executor/#job-creation) for more information about job definition types. (optional)
      jobDefinitionConfiguration - Filter by job definition configuration. (optional)
      activityIdIn - Only include historic job logs which belong to one of the passed activity ids. (optional)
      failedActivityIdIn - Only include historic job logs which belong to failures of one of the passed activity ids. (optional)
      executionIdIn - Only include historic job logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      deploymentId - Filter by deployment id. (optional)
      tenantIdIn - Only include historic job log entries which belong to one of the passed and comma- separated tenant ids. (optional)
      withoutTenantId - Only include historic job log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      hostname - Filter by hostname. (optional)
      jobPriorityLowerThanOrEquals - Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      jobPriorityHigherThanOrEquals - Only include logs for which the associated job had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (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)
      Returns:
      List<HistoricJobLogDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricJobLogs

      public List<HistoricJobLogDto> getHistoricJobLogs(String logId, String jobId, String jobExceptionMessage, String jobDefinitionId, String jobDefinitionType, String jobDefinitionConfiguration, String activityIdIn, String failedActivityIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String deploymentId, String tenantIdIn, Boolean withoutTenantId, String hostname, Long jobPriorityLowerThanOrEquals, Long jobPriorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Job Logs Queries for historic job logs that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Job Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query-count/) method.
      Parameters:
      logId - Filter by historic job log id. (optional)
      jobId - Filter by job id. (optional)
      jobExceptionMessage - Filter by job exception message. (optional)
      jobDefinitionId - Filter by job definition id. (optional)
      jobDefinitionType - Filter by job definition type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/the-job-executor/#job-creation) for more information about job definition types. (optional)
      jobDefinitionConfiguration - Filter by job definition configuration. (optional)
      activityIdIn - Only include historic job logs which belong to one of the passed activity ids. (optional)
      failedActivityIdIn - Only include historic job logs which belong to failures of one of the passed activity ids. (optional)
      executionIdIn - Only include historic job logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      deploymentId - Filter by deployment id. (optional)
      tenantIdIn - Only include historic job log entries which belong to one of the passed and comma- separated tenant ids. (optional)
      withoutTenantId - Only include historic job log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      hostname - Filter by hostname. (optional)
      jobPriorityLowerThanOrEquals - Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      jobPriorityHigherThanOrEquals - Only include logs for which the associated job had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricJobLogDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricJobLogsCount

      public CountResultDto getHistoricJobLogsCount(String logId, String jobId, String jobExceptionMessage, String jobDefinitionId, String jobDefinitionType, String jobDefinitionConfiguration, String activityIdIn, String failedActivityIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String deploymentId, String tenantIdIn, Boolean withoutTenantId, String hostname, Long jobPriorityLowerThanOrEquals, Long jobPriorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog) throws ApiException
      Get Job Log Count Queries for the number of historic job logs that fulfill the given parameters. Takes the same parameters as the [Get Job Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query/) method.
      Parameters:
      logId - Filter by historic job log id. (optional)
      jobId - Filter by job id. (optional)
      jobExceptionMessage - Filter by job exception message. (optional)
      jobDefinitionId - Filter by job definition id. (optional)
      jobDefinitionType - Filter by job definition type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/the-job-executor/#job-creation) for more information about job definition types. (optional)
      jobDefinitionConfiguration - Filter by job definition configuration. (optional)
      activityIdIn - Only include historic job logs which belong to one of the passed activity ids. (optional)
      failedActivityIdIn - Only include historic job logs which belong to failures of one of the passed activity ids. (optional)
      executionIdIn - Only include historic job logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      deploymentId - Filter by deployment id. (optional)
      tenantIdIn - Only include historic job log entries which belong to one of the passed and comma- separated tenant ids. (optional)
      withoutTenantId - Only include historic job log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      hostname - Filter by hostname. (optional)
      jobPriorityLowerThanOrEquals - Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      jobPriorityHigherThanOrEquals - Only include logs for which the associated job had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricJobLogsCount

      public CountResultDto getHistoricJobLogsCount(String logId, String jobId, String jobExceptionMessage, String jobDefinitionId, String jobDefinitionType, String jobDefinitionConfiguration, String activityIdIn, String failedActivityIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String deploymentId, String tenantIdIn, Boolean withoutTenantId, String hostname, Long jobPriorityLowerThanOrEquals, Long jobPriorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, Map<String,String> additionalHeaders) throws ApiException
      Get Job Log Count Queries for the number of historic job logs that fulfill the given parameters. Takes the same parameters as the [Get Job Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query/) method.
      Parameters:
      logId - Filter by historic job log id. (optional)
      jobId - Filter by job id. (optional)
      jobExceptionMessage - Filter by job exception message. (optional)
      jobDefinitionId - Filter by job definition id. (optional)
      jobDefinitionType - Filter by job definition type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/the-job-executor/#job-creation) for more information about job definition types. (optional)
      jobDefinitionConfiguration - Filter by job definition configuration. (optional)
      activityIdIn - Only include historic job logs which belong to one of the passed activity ids. (optional)
      failedActivityIdIn - Only include historic job logs which belong to failures of one of the passed activity ids. (optional)
      executionIdIn - Only include historic job logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      deploymentId - Filter by deployment id. (optional)
      tenantIdIn - Only include historic job log entries which belong to one of the passed and comma- separated tenant ids. (optional)
      withoutTenantId - Only include historic job log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      hostname - Filter by hostname. (optional)
      jobPriorityLowerThanOrEquals - Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      jobPriorityHigherThanOrEquals - Only include logs for which the associated job had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getStacktraceHistoricJobLog

      public Object getStacktraceHistoricJobLog(String id) throws ApiException
      Get Job Log Exception Stacktrace Retrieves the corresponding exception stacktrace to the passed historic job log by id.
      Parameters:
      id - The id of the historic job log to get the exception stacktrace for. (required)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • getStacktraceHistoricJobLog

      public Object getStacktraceHistoricJobLog(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Job Log Exception Stacktrace Retrieves the corresponding exception stacktrace to the passed historic job log by id.
      Parameters:
      id - The id of the historic job log to get the exception stacktrace for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • queryHistoricJobLogs

      public List<HistoricJobLogDto> queryHistoricJobLogs(Integer firstResult, Integer maxResults, HistoricJobLogQueryDto historicJobLogQueryDto) throws ApiException
      Get Job Logs (POST) Queries for historic job logs that fulfill the given parameters. This method is slightly more powerful than the [Get Job Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query/) method because it allows filtering by historic job logs values of the different types `String`, `Number` or `Boolean`.
      Parameters:
      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)
      historicJobLogQueryDto - (optional)
      Returns:
      List<HistoricJobLogDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricJobLogs

      public List<HistoricJobLogDto> queryHistoricJobLogs(Integer firstResult, Integer maxResults, HistoricJobLogQueryDto historicJobLogQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get Job Logs (POST) Queries for historic job logs that fulfill the given parameters. This method is slightly more powerful than the [Get Job Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query/) method because it allows filtering by historic job logs values of the different types `String`, `Number` or `Boolean`.
      Parameters:
      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)
      historicJobLogQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricJobLogDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricJobLogsCount

      public CountResultDto queryHistoricJobLogsCount(HistoricJobLogQueryDto historicJobLogQueryDto) throws ApiException
      Get Job Log Count (POST) Queries for the number of historic job logs that fulfill the given parameters. This method takes the same message body as the [Get Job Logs (POST)](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/post-job-log-query/) method and therefore it is slightly more powerful than the [Get Job Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query-count/) method.
      Parameters:
      historicJobLogQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryHistoricJobLogsCount

      public CountResultDto queryHistoricJobLogsCount(HistoricJobLogQueryDto historicJobLogQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get Job Log Count (POST) Queries for the number of historic job logs that fulfill the given parameters. This method takes the same message body as the [Get Job Logs (POST)](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/post-job-log-query/) method and therefore it is slightly more powerful than the [Get Job Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/job-log/get-job-log-query-count/) method.
      Parameters:
      historicJobLogQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call