Package org.openapitools.client.api

Class JobApi

  • public class JobApi
extends Object

    • Constructor Detail

      • JobApi

        public JobApi()

      • JobApi

        public JobApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • executeJobCall

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

      • executeJob

        public void executeJob​(String id)
                throws ApiException
        Execute Job Executes a job by id. **Note:** The execution of the job happens synchronously in the same thread.
        Parameters:
        id - The id of the job to be executed. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeJobWithHttpInfo

        public ApiResponse<Void> executeJobWithHttpInfo​(String id)
                                         throws ApiException
        Execute Job Executes a job by id. **Note:** The execution of the job happens synchronously in the same thread.
        Parameters:
        id - The id of the job to be executed. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeJobAsync

        public okhttp3.Call executeJobAsync​(String id,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Execute Job (asynchronously) Executes a job by id. **Note:** The execution of the job happens synchronously in the same thread.
        Parameters:
        id - The id of the job to be executed. (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

      • getJobCall

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

      • getJob

        public JobDto getJob​(String id)
              throws ApiException
        Get Job Retrieves a job by id, according to the `Job` interface in the engine.
        Parameters:
        id - The id of the job to be retrieved. (required)
        Returns:
        JobDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobWithHttpInfo

        public ApiResponse<JobDto> getJobWithHttpInfo​(String id)
                                       throws ApiException
        Get Job Retrieves a job by id, according to the `Job` interface in the engine.
        Parameters:
        id - The id of the job to be retrieved. (required)
        Returns:
        ApiResponse<JobDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobAsync

        public okhttp3.Call getJobAsync​(String id,
                                ApiCallback<JobDto> _callback)
                         throws ApiException
        Get Job (asynchronously) Retrieves a job by id, according to the `Job` interface in the engine.
        Parameters:
        id - The id of the job to be retrieved. (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

      • getJobsCall

        public okhttp3.Call getJobsCall​(String jobId,
                                String jobIds,
                                String jobDefinitionId,
                                String processInstanceId,
                                String processInstanceIds,
                                String executionId,
                                String processDefinitionId,
                                String processDefinitionKey,
                                String activityId,
                                Boolean withRetriesLeft,
                                Boolean executable,
                                Boolean timers,
                                Boolean messages,
                                String dueDates,
                                String createTimes,
                                Boolean withException,
                                String exceptionMessage,
                                String failedActivityId,
                                Boolean noRetriesLeft,
                                Boolean active,
                                Boolean suspended,
                                Long priorityLowerThanOrEquals,
                                Long priorityHigherThanOrEquals,
                                String tenantIdIn,
                                Boolean withoutTenantId,
                                Boolean includeJobsWithoutTenantId,
                                String sortBy,
                                String sortOrder,
                                Integer firstResult,
                                Integer maxResults,
                                ApiCallback _callback)
                         throws ApiException
        Build call for getJobs
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getJobs

        public List<JobDto> getJobs​(String jobId,
                            String jobIds,
                            String jobDefinitionId,
                            String processInstanceId,
                            String processInstanceIds,
                            String executionId,
                            String processDefinitionId,
                            String processDefinitionKey,
                            String activityId,
                            Boolean withRetriesLeft,
                            Boolean executable,
                            Boolean timers,
                            Boolean messages,
                            String dueDates,
                            String createTimes,
                            Boolean withException,
                            String exceptionMessage,
                            String failedActivityId,
                            Boolean noRetriesLeft,
                            Boolean active,
                            Boolean suspended,
                            Long priorityLowerThanOrEquals,
                            Long priorityHigherThanOrEquals,
                            String tenantIdIn,
                            Boolean withoutTenantId,
                            Boolean includeJobsWithoutTenantId,
                            String sortBy,
                            String sortOrder,
                            Integer firstResult,
                            Integer maxResults)
                     throws ApiException
        Get Jobs Queries for jobs that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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<JobDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobsWithHttpInfo

        public ApiResponse<List<JobDto>> getJobsWithHttpInfo​(String jobId,
                                                     String jobIds,
                                                     String jobDefinitionId,
                                                     String processInstanceId,
                                                     String processInstanceIds,
                                                     String executionId,
                                                     String processDefinitionId,
                                                     String processDefinitionKey,
                                                     String activityId,
                                                     Boolean withRetriesLeft,
                                                     Boolean executable,
                                                     Boolean timers,
                                                     Boolean messages,
                                                     String dueDates,
                                                     String createTimes,
                                                     Boolean withException,
                                                     String exceptionMessage,
                                                     String failedActivityId,
                                                     Boolean noRetriesLeft,
                                                     Boolean active,
                                                     Boolean suspended,
                                                     Long priorityLowerThanOrEquals,
                                                     Long priorityHigherThanOrEquals,
                                                     String tenantIdIn,
                                                     Boolean withoutTenantId,
                                                     Boolean includeJobsWithoutTenantId,
                                                     String sortBy,
                                                     String sortOrder,
                                                     Integer firstResult,
                                                     Integer maxResults)
                                              throws ApiException
        Get Jobs Queries for jobs that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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<JobDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobsAsync

        public okhttp3.Call getJobsAsync​(String jobId,
                                 String jobIds,
                                 String jobDefinitionId,
                                 String processInstanceId,
                                 String processInstanceIds,
                                 String executionId,
                                 String processDefinitionId,
                                 String processDefinitionKey,
                                 String activityId,
                                 Boolean withRetriesLeft,
                                 Boolean executable,
                                 Boolean timers,
                                 Boolean messages,
                                 String dueDates,
                                 String createTimes,
                                 Boolean withException,
                                 String exceptionMessage,
                                 String failedActivityId,
                                 Boolean noRetriesLeft,
                                 Boolean active,
                                 Boolean suspended,
                                 Long priorityLowerThanOrEquals,
                                 Long priorityHigherThanOrEquals,
                                 String tenantIdIn,
                                 Boolean withoutTenantId,
                                 Boolean includeJobsWithoutTenantId,
                                 String sortBy,
                                 String sortOrder,
                                 Integer firstResult,
                                 Integer maxResults,
                                 ApiCallback<List<JobDto>> _callback)
                          throws ApiException
        Get Jobs (asynchronously) Queries for jobs that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getJobsCountCall

        public okhttp3.Call getJobsCountCall​(String jobId,
                                     String jobIds,
                                     String jobDefinitionId,
                                     String processInstanceId,
                                     String processInstanceIds,
                                     String executionId,
                                     String processDefinitionId,
                                     String processDefinitionKey,
                                     String activityId,
                                     Boolean withRetriesLeft,
                                     Boolean executable,
                                     Boolean timers,
                                     Boolean messages,
                                     String dueDates,
                                     String createTimes,
                                     Boolean withException,
                                     String exceptionMessage,
                                     String failedActivityId,
                                     Boolean noRetriesLeft,
                                     Boolean active,
                                     Boolean suspended,
                                     Long priorityLowerThanOrEquals,
                                     Long priorityHigherThanOrEquals,
                                     String tenantIdIn,
                                     Boolean withoutTenantId,
                                     Boolean includeJobsWithoutTenantId,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for getJobsCount
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getJobsCount

        public CountResultDto getJobsCount​(String jobId,
                                   String jobIds,
                                   String jobDefinitionId,
                                   String processInstanceId,
                                   String processInstanceIds,
                                   String executionId,
                                   String processDefinitionId,
                                   String processDefinitionKey,
                                   String activityId,
                                   Boolean withRetriesLeft,
                                   Boolean executable,
                                   Boolean timers,
                                   Boolean messages,
                                   String dueDates,
                                   String createTimes,
                                   Boolean withException,
                                   String exceptionMessage,
                                   String failedActivityId,
                                   Boolean noRetriesLeft,
                                   Boolean active,
                                   Boolean suspended,
                                   Long priorityLowerThanOrEquals,
                                   Long priorityHigherThanOrEquals,
                                   String tenantIdIn,
                                   Boolean withoutTenantId,
                                   Boolean includeJobsWithoutTenantId)
                            throws ApiException
        Get Job Count Queries for the number of jobs that fulfill given parameters. Takes the same parameters as the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getJobsCountWithHttpInfo

        public ApiResponse<CountResultDto> getJobsCountWithHttpInfo​(String jobId,
                                                            String jobIds,
                                                            String jobDefinitionId,
                                                            String processInstanceId,
                                                            String processInstanceIds,
                                                            String executionId,
                                                            String processDefinitionId,
                                                            String processDefinitionKey,
                                                            String activityId,
                                                            Boolean withRetriesLeft,
                                                            Boolean executable,
                                                            Boolean timers,
                                                            Boolean messages,
                                                            String dueDates,
                                                            String createTimes,
                                                            Boolean withException,
                                                            String exceptionMessage,
                                                            String failedActivityId,
                                                            Boolean noRetriesLeft,
                                                            Boolean active,
                                                            Boolean suspended,
                                                            Long priorityLowerThanOrEquals,
                                                            Long priorityHigherThanOrEquals,
                                                            String tenantIdIn,
                                                            Boolean withoutTenantId,
                                                            Boolean includeJobsWithoutTenantId)
                                                     throws ApiException
        Get Job Count Queries for the number of jobs that fulfill given parameters. Takes the same parameters as the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getJobsCountAsync

        public okhttp3.Call getJobsCountAsync​(String jobId,
                                      String jobIds,
                                      String jobDefinitionId,
                                      String processInstanceId,
                                      String processInstanceIds,
                                      String executionId,
                                      String processDefinitionId,
                                      String processDefinitionKey,
                                      String activityId,
                                      Boolean withRetriesLeft,
                                      Boolean executable,
                                      Boolean timers,
                                      Boolean messages,
                                      String dueDates,
                                      String createTimes,
                                      Boolean withException,
                                      String exceptionMessage,
                                      String failedActivityId,
                                      Boolean noRetriesLeft,
                                      Boolean active,
                                      Boolean suspended,
                                      Long priorityLowerThanOrEquals,
                                      Long priorityHigherThanOrEquals,
                                      String tenantIdIn,
                                      Boolean withoutTenantId,
                                      Boolean includeJobsWithoutTenantId,
                                      ApiCallback<CountResultDto> _callback)
                               throws ApiException
        Get Job Count (asynchronously) Queries for the number of jobs that fulfill given parameters. Takes the same parameters as the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method.
        Parameters:
        jobId - Filter by job id. (optional)
        jobIds - Filter by a comma-separated list of job ids. (optional)
        jobDefinitionId - Only select jobs which exist for the given job definition. (optional)
        processInstanceId - Only select jobs which exist for the given process instance. (optional)
        processInstanceIds - Only select jobs which exist for the given comma-separated list of process instance ids. (optional)
        executionId - Only select jobs which exist for the given execution. (optional)
        processDefinitionId - Filter by the id of the process definition the jobs run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the jobs run on. (optional)
        activityId - Only select jobs which exist for an activity with the given id. (optional)
        withRetriesLeft - Only select jobs which have retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        executable - Only select jobs which are executable, i.e., retries > 0 and due date is `null` or due date is in the past. Value may only be `true`, as `false` is the default behavior. (optional)
        timers - Only select jobs that are timers. Cannot be used together with `messages`. Value may only be `true`, as `false` is the default behavior. (optional)
        messages - Only select jobs that are messages. Cannot be used together with `timers`. Value may only be `true`, as `false` is the default behavior. (optional)
        dueDates - Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        createTimes - Only select jobs created before or after the given date. Create time expressions are comma-separated and are structured as follows: A valid condition value has the form `operator_value`. `operator` is the comparison operator to be used and `value` the date value as string. Valid operator values are: `gt` - greater than; `lt` - lower than. `value` may not contain underscore or comma characters. (optional)
        withException - Only select jobs that failed due to an exception. Value may only be `true`, as `false` is the default behavior. (optional)
        exceptionMessage - Only select jobs that failed due to an exception with the given message. (optional)
        failedActivityId - Only select jobs that failed due to an exception at an activity with the given id. (optional)
        noRetriesLeft - Only select jobs which have no retries left. Value may only be `true`, as `false` is the default behavior. (optional)
        active - Only include active jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended jobs. Value may only be `true`, as `false` is the default behavior. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        tenantIdIn - Only include jobs which belong to one of the passed comma-separated tenant ids. (optional)
        withoutTenantId - Only include jobs which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobsWithoutTenantId - Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`. 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

      • getStacktraceCall

        public okhttp3.Call getStacktraceCall​(String id,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getStacktrace
        Parameters:
        id - The id of the job 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

      • getStacktrace

        public Object getStacktrace​(String id)
                     throws ApiException
        Get Exception Stacktrace Retrieves the exception stacktrace corresponding to the passed job id.
        Parameters:
        id - The id of the job 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

      • getStacktraceWithHttpInfo

        public ApiResponse<Object> getStacktraceWithHttpInfo​(String id)
                                              throws ApiException
        Get Exception Stacktrace Retrieves the exception stacktrace corresponding to the passed job id.
        Parameters:
        id - The id of the job 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

      • getStacktraceAsync

        public okhttp3.Call getStacktraceAsync​(String id,
                                       ApiCallback<Object> _callback)
                                throws ApiException
        Get Exception Stacktrace (asynchronously) Retrieves the exception stacktrace corresponding to the passed job id.
        Parameters:
        id - The id of the job 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

      • queryJobsCall

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

      • queryJobs

        public List<JobDto> queryJobs​(Integer firstResult,
                              Integer maxResults,
                              JobQueryDto jobQueryDto)
                       throws ApiException
        Get Jobs (POST) Queries for jobs that fulfill given parameters. This method is slightly more powerful than the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method because it allows filtering by multiple jobs of 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)
        jobQueryDto - (optional)
        Returns:
        List<JobDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobsWithHttpInfo

        public ApiResponse<List<JobDto>> queryJobsWithHttpInfo​(Integer firstResult,
                                                       Integer maxResults,
                                                       JobQueryDto jobQueryDto)
                                                throws ApiException
        Get Jobs (POST) Queries for jobs that fulfill given parameters. This method is slightly more powerful than the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method because it allows filtering by multiple jobs of 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)
        jobQueryDto - (optional)
        Returns:
        ApiResponse<List<JobDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobsAsync

        public okhttp3.Call queryJobsAsync​(Integer firstResult,
                                   Integer maxResults,
                                   JobQueryDto jobQueryDto,
                                   ApiCallback<List<JobDto>> _callback)
                            throws ApiException
        Get Jobs (POST) (asynchronously) Queries for jobs that fulfill given parameters. This method is slightly more powerful than the [Get Jobs](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query/) method because it allows filtering by multiple jobs of 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)
        jobQueryDto - (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

      • queryJobsCountCall

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

      • queryJobsCount

        public CountResultDto queryJobsCount​(JobQueryDto jobQueryDto)
                              throws ApiException
        Get Job Count (POST) Queries for jobs that fulfill given parameters. This method takes the same message body as the [Get Jobs POST](https://docs.camunda.org/manual/7.18/reference/rest/job/post- query/) method and therefore it is slightly more powerful than the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobsCountWithHttpInfo

        public ApiResponse<CountResultDto> queryJobsCountWithHttpInfo​(JobQueryDto jobQueryDto)
                                                       throws ApiException
        Get Job Count (POST) Queries for jobs that fulfill given parameters. This method takes the same message body as the [Get Jobs POST](https://docs.camunda.org/manual/7.18/reference/rest/job/post- query/) method and therefore it is slightly more powerful than the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobsCountAsync

        public okhttp3.Call queryJobsCountAsync​(JobQueryDto jobQueryDto,
                                        ApiCallback<CountResultDto> _callback)
                                 throws ApiException
        Get Job Count (POST) (asynchronously) Queries for jobs that fulfill given parameters. This method takes the same message body as the [Get Jobs POST](https://docs.camunda.org/manual/7.18/reference/rest/job/post- query/) method and therefore it is slightly more powerful than the [Get Job Count](https://docs.camunda.org/manual/7.18/reference/rest/job/get-query-count/) method.
        Parameters:
        jobQueryDto - (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

      • recalculateDuedateCall

        public okhttp3.Call recalculateDuedateCall​(String id,
                                           Boolean creationDateBased,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for recalculateDuedate
        Parameters:
        id - The id of the job to be updated. (required)
        creationDateBased - Recalculate the due date based on the creation date of the job or the current date. Value may only be `false`, as `true` 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

      • recalculateDuedate

        public void recalculateDuedate​(String id,
                               Boolean creationDateBased)
                        throws ApiException
        Recalculate Job Due Date Recalculates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        creationDateBased - Recalculate the due date based on the creation date of the job or the current date. Value may only be `false`, as `true` is the default behavior. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recalculateDuedateWithHttpInfo

        public ApiResponse<Void> recalculateDuedateWithHttpInfo​(String id,
                                                        Boolean creationDateBased)
                                                 throws ApiException
        Recalculate Job Due Date Recalculates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        creationDateBased - Recalculate the due date based on the creation date of the job or the current date. Value may only be `false`, as `true` is the default behavior. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recalculateDuedateAsync

        public okhttp3.Call recalculateDuedateAsync​(String id,
                                            Boolean creationDateBased,
                                            ApiCallback<Void> _callback)
                                     throws ApiException
        Recalculate Job Due Date (asynchronously) Recalculates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        creationDateBased - Recalculate the due date based on the creation date of the job or the current date. Value may only be `false`, as `true` 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

      • setJobDuedateCall

        public okhttp3.Call setJobDuedateCall​(String id,
                                      JobDuedateDto jobDuedateDto,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for setJobDuedate
        Parameters:
        id - The id of the job to be updated. (required)
        jobDuedateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setJobDuedate

        public void setJobDuedate​(String id,
                          JobDuedateDto jobDuedateDto)
                   throws ApiException
        Set Job Due Date Updates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        jobDuedateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobDuedateWithHttpInfo

        public ApiResponse<Void> setJobDuedateWithHttpInfo​(String id,
                                                   JobDuedateDto jobDuedateDto)
                                            throws ApiException
        Set Job Due Date Updates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        jobDuedateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobDuedateAsync

        public okhttp3.Call setJobDuedateAsync​(String id,
                                       JobDuedateDto jobDuedateDto,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Set Job Due Date (asynchronously) Updates the due date of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        jobDuedateDto - (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

      • setJobPriorityCall

        public okhttp3.Call setJobPriorityCall​(String id,
                                       PriorityDto priorityDto,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for setJobPriority
        Parameters:
        id - The id of the job to be updated. (required)
        priorityDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setJobPriority

        public void setJobPriority​(String id,
                           PriorityDto priorityDto)
                    throws ApiException
        Set Job Priority Sets the execution priority of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        priorityDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobPriorityWithHttpInfo

        public ApiResponse<Void> setJobPriorityWithHttpInfo​(String id,
                                                    PriorityDto priorityDto)
                                             throws ApiException
        Set Job Priority Sets the execution priority of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        priorityDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobPriorityAsync

        public okhttp3.Call setJobPriorityAsync​(String id,
                                        PriorityDto priorityDto,
                                        ApiCallback<Void> _callback)
                                 throws ApiException
        Set Job Priority (asynchronously) Sets the execution priority of a job by id.
        Parameters:
        id - The id of the job to be updated. (required)
        priorityDto - (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

      • setJobRetriesCall

        public okhttp3.Call setJobRetriesCall​(String id,
                                      RetriesDto retriesDto,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for setJobRetries
        Parameters:
        id - The id of the job to be updated. (required)
        retriesDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setJobRetries

        public void setJobRetries​(String id,
                          RetriesDto retriesDto)
                   throws ApiException
        Set Job Retries Sets the retries of the job to the given number of retries by id.
        Parameters:
        id - The id of the job to be updated. (required)
        retriesDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesWithHttpInfo

        public ApiResponse<Void> setJobRetriesWithHttpInfo​(String id,
                                                   RetriesDto retriesDto)
                                            throws ApiException
        Set Job Retries Sets the retries of the job to the given number of retries by id.
        Parameters:
        id - The id of the job to be updated. (required)
        retriesDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesAsync

        public okhttp3.Call setJobRetriesAsync​(String id,
                                       RetriesDto retriesDto,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Set Job Retries (asynchronously) Sets the retries of the job to the given number of retries by id.
        Parameters:
        id - The id of the job to be updated. (required)
        retriesDto - (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

      • setJobRetriesAsyncOperationCall

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

      • setJobRetriesAsyncOperation

        public BatchDto setJobRetriesAsyncOperation​(SetJobRetriesDto setJobRetriesDto)
                                     throws ApiException
        Set Job Retries Async (POST) Create a batch to set retries of jobs asynchronously.
        Parameters:
        setJobRetriesDto - (optional)
        Returns:
        BatchDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesAsyncOperationWithHttpInfo

        public ApiResponse<BatchDto> setJobRetriesAsyncOperationWithHttpInfo​(SetJobRetriesDto setJobRetriesDto)
                                                              throws ApiException
        Set Job Retries Async (POST) Create a batch to set retries of jobs asynchronously.
        Parameters:
        setJobRetriesDto - (optional)
        Returns:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesAsyncOperationAsync

        public okhttp3.Call setJobRetriesAsyncOperationAsync​(SetJobRetriesDto setJobRetriesDto,
                                                     ApiCallback<BatchDto> _callback)
                                              throws ApiException
        Set Job Retries Async (POST) (asynchronously) Create a batch to set retries of jobs asynchronously.
        Parameters:
        setJobRetriesDto - (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

      • updateJobSuspensionStateCall

        public okhttp3.Call updateJobSuspensionStateCall​(String id,
                                                 SuspensionStateDto suspensionStateDto,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for updateJobSuspensionState
        Parameters:
        id - The id of the job to activate or suspend. (required)
        suspensionStateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateJobSuspensionState

        public void updateJobSuspensionState​(String id,
                                     SuspensionStateDto suspensionStateDto)
                              throws ApiException
        Activate/Suspend Job By Id Activates or suspends a given job by id.
        Parameters:
        id - The id of the job to activate or suspend. (required)
        suspensionStateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateJobSuspensionStateWithHttpInfo

        public ApiResponse<Void> updateJobSuspensionStateWithHttpInfo​(String id,
                                                              SuspensionStateDto suspensionStateDto)
                                                       throws ApiException
        Activate/Suspend Job By Id Activates or suspends a given job by id.
        Parameters:
        id - The id of the job to activate or suspend. (required)
        suspensionStateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateJobSuspensionStateAsync

        public okhttp3.Call updateJobSuspensionStateAsync​(String id,
                                                  SuspensionStateDto suspensionStateDto,
                                                  ApiCallback<Void> _callback)
                                           throws ApiException
        Activate/Suspend Job By Id (asynchronously) Activates or suspends a given job by id.
        Parameters:
        id - The id of the job to activate or suspend. (required)
        suspensionStateDto - (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

      • updateSuspensionStateByCall

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

      • updateSuspensionStateBy

        public void updateSuspensionStateBy​(JobSuspensionStateDto jobSuspensionStateDto)
                             throws ApiException
        Activate/Suspend Jobs Activates or suspends jobs matching the given criterion. This can only be on of: * `jobDefinitionId` * `processDefinitionId` * `processInstanceId` * `processDefinitionKey`
        Parameters:
        jobSuspensionStateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateByWithHttpInfo

        public ApiResponse<Void> updateSuspensionStateByWithHttpInfo​(JobSuspensionStateDto jobSuspensionStateDto)
                                                      throws ApiException
        Activate/Suspend Jobs Activates or suspends jobs matching the given criterion. This can only be on of: * `jobDefinitionId` * `processDefinitionId` * `processInstanceId` * `processDefinitionKey`
        Parameters:
        jobSuspensionStateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateByAsync

        public okhttp3.Call updateSuspensionStateByAsync​(JobSuspensionStateDto jobSuspensionStateDto,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException
        Activate/Suspend Jobs (asynchronously) Activates or suspends jobs matching the given criterion. This can only be on of: * `jobDefinitionId` * `processDefinitionId` * `processInstanceId` * `processDefinitionKey`
        Parameters:
        jobSuspensionStateDto - (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