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

Class JobApi

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

  • Constructor Details

    • JobApi

      public JobApi()

    • JobApi

      public JobApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteJob

      public void deleteJob(String id) throws ApiException
      Delete Job Deletes a job by id.
      Parameters:
      id - The id of the job to be deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteJob

      public void deleteJob(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Job Deletes a job by id.
      Parameters:
      id - The id of the job to be deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • executeJob

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

    • 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 fails to make API call

    • getJob

      public JobDto getJob(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JobDto
      Throws:
      ApiException - if fails to make API call

    • 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.21/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 fails to make API call

    • 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, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JobDto>
      Throws:
      ApiException - if fails to make API call

    • 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.21/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 fails to make API call

    • 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, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • getStacktrace

      public Object getStacktrace(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • 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.21/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 fails to make API call

    • queryJobs

      public List<JobDto> queryJobs(Integer firstResult, Integer maxResults, JobQueryDto jobQueryDto, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JobDto>
      Throws:
      ApiException - if fails to make API call

    • 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.21/reference/rest/job/post- query/) method and therefore it is slightly more powerful than the [Get Job Count](https://docs.camunda.org/manual/7.21/reference/rest/job/get-query-count/) method.
      Parameters:
      jobQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryJobsCount

      public CountResultDto queryJobsCount(JobQueryDto jobQueryDto, Map<String,String> additionalHeaders) 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.21/reference/rest/job/post- query/) method and therefore it is slightly more powerful than the [Get Job Count](https://docs.camunda.org/manual/7.21/reference/rest/job/get-query-count/) method.
      Parameters:
      jobQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • recalculateDuedate

      public void recalculateDuedate(String id, Boolean creationDateBased, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • setJobDuedate

      public void setJobDuedate(String id, JobDuedateDto jobDuedateDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • setJobPriority

      public void setJobPriority(String id, PriorityDto priorityDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • setJobRetries

      public void setJobRetries(String id, JobRetriesDto jobRetriesDto) 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)
      jobRetriesDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • setJobRetries

      public void setJobRetries(String id, JobRetriesDto jobRetriesDto, Map<String,String> additionalHeaders) 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)
      jobRetriesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • setJobRetriesAsyncOperation

      public BatchDto setJobRetriesAsyncOperation(SetJobRetriesDto setJobRetriesDto, Map<String,String> additionalHeaders) throws ApiException
      Set Job Retries Async (POST) Create a batch to set retries of jobs asynchronously.
      Parameters:
      setJobRetriesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • updateJobSuspensionState

      public void updateJobSuspensionState(String id, SuspensionStateDto suspensionStateDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • updateSuspensionStateBy

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