Package org.openapitools.client.api

Class HistoricJobLogApi

  • public class HistoricJobLogApi
extends Object

    • Constructor Detail

      • HistoricJobLogApi

        public HistoricJobLogApi()

      • HistoricJobLogApi

        public HistoricJobLogApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHistoricJobLogCall

        public okhttp3.Call getHistoricJobLogCall​(String id,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for getHistoricJobLog
        Parameters:
        id - The id of the log entry. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogWithHttpInfo

        public ApiResponse<HistoricJobLogDto> getHistoricJobLogWithHttpInfo​(String id)
                                                             throws ApiException
        Get Job Log Retrieves a historic job log by id.
        Parameters:
        id - The id of the log entry. (required)
        Returns:
        ApiResponse<HistoricJobLogDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogAsync

        public okhttp3.Call getHistoricJobLogAsync​(String id,
                                           ApiCallback<HistoricJobLogDto> _callback)
                                    throws ApiException
        Get Job Log (asynchronously) Retrieves a historic job log by id.
        Parameters:
        id - The id of the log entry. (required)
        _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

      • getHistoricJobLogsCall

        public okhttp3.Call getHistoricJobLogsCall​(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,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getHistoricJobLogs
        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.18/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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogsWithHttpInfo

        public ApiResponse<List<HistoricJobLogDto>> getHistoricJobLogsWithHttpInfo​(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.18/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.18/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:
        ApiResponse<List<HistoricJobLogDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogsAsync

        public okhttp3.Call getHistoricJobLogsAsync​(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,
                                            ApiCallback<List<HistoricJobLogDto>> _callback)
                                     throws ApiException
        Get Job Logs (asynchronously) 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.18/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.18/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)
        _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

      • getHistoricJobLogsCountCall

        public okhttp3.Call getHistoricJobLogsCountCall​(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,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getHistoricJobLogsCount
        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.18/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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogsCountWithHttpInfo

        public ApiResponse<CountResultDto> getHistoricJobLogsCountWithHttpInfo​(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.18/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.18/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:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricJobLogsCountAsync

        public okhttp3.Call getHistoricJobLogsCountAsync​(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,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get Job Log Count (asynchronously) 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.18/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.18/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)
        _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

      • getStacktraceHistoricJobLogCall

        public okhttp3.Call getStacktraceHistoricJobLogCall​(String id,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getStacktraceHistoricJobLog
        Parameters:
        id - The id of the historic job log to get the exception stacktrace for. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getStacktraceHistoricJobLogWithHttpInfo

        public ApiResponse<Object> getStacktraceHistoricJobLogWithHttpInfo​(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:
        ApiResponse<Object>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getStacktraceHistoricJobLogAsync

        public okhttp3.Call getStacktraceHistoricJobLogAsync​(String id,
                                                     ApiCallback<Object> _callback)
                                              throws ApiException
        Get Job Log Exception Stacktrace (asynchronously) 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)
        _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

      • queryHistoricJobLogsCall

        public okhttp3.Call queryHistoricJobLogsCall​(Integer firstResult,
                                             Integer maxResults,
                                             HistoricJobLogQueryDto historicJobLogQueryDto,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for queryHistoricJobLogs
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricJobLogsWithHttpInfo

        public ApiResponse<List<HistoricJobLogDto>> queryHistoricJobLogsWithHttpInfo​(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.18/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:
        ApiResponse<List<HistoricJobLogDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricJobLogsAsync

        public okhttp3.Call queryHistoricJobLogsAsync​(Integer firstResult,
                                              Integer maxResults,
                                              HistoricJobLogQueryDto historicJobLogQueryDto,
                                              ApiCallback<List<HistoricJobLogDto>> _callback)
                                       throws ApiException
        Get Job Logs (POST) (asynchronously) 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.18/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)
        _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

      • queryHistoricJobLogsCountCall

        public okhttp3.Call queryHistoricJobLogsCountCall​(HistoricJobLogQueryDto historicJobLogQueryDto,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for queryHistoricJobLogsCount
        Parameters:
        historicJobLogQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/reference/rest/history/job-log/get-job-log-query-count/) method.
        Parameters:
        historicJobLogQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricJobLogsCountWithHttpInfo

        public ApiResponse<CountResultDto> queryHistoricJobLogsCountWithHttpInfo​(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.18/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.18/reference/rest/history/job-log/get-job-log-query-count/) method.
        Parameters:
        historicJobLogQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricJobLogsCountAsync

        public okhttp3.Call queryHistoricJobLogsCountAsync​(HistoricJobLogQueryDto historicJobLogQueryDto,
                                                   ApiCallback<CountResultDto> _callback)
                                            throws ApiException
        Get Job Log Count (POST) (asynchronously) 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.18/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.18/reference/rest/history/job-log/get-job-log-query-count/) method.
        Parameters:
        historicJobLogQueryDto - (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