Package org.camunda.bpm.engine.management

Interface SetJobRetriesBuilder

All Known Implementing Classes:
SetJobRetriesBuilderImpl
public interface SetJobRetriesBuilder
Fluent builder to update the number of retries for one or multiple jobs synchronously.

  • Method Details

    • jobId

      SetJobRetriesBuilder jobId(String jobId)
      Specifies a single Job by it's ID for the set retries action. Note: Only one method of referencing jobs is allowed. If you use jobId, you can not use jobIds or jobDefinitionId.
      Parameters:
      jobId - the Id of the job. Must not be null or empty ("").
      Returns:
      the builder instance
      See Also:

    • jobIds

      SetJobRetriesBuilder jobIds(List<String> jobIds)
      Specifies a list of jobs by their IDs for the set retries action. Note: Only one method of referencing jobs is allowed. If you use jobIds, you can not use jobId or jobDefinitionId.
      Parameters:
      jobIds - the list of job ids. Must not be null or empty and only contain valid job ids.
      Returns:
      the builder instance
      See Also:

    • jobDefinitionId

      SetJobRetriesBuilder jobDefinitionId(String jobDefinitionId)
      Specifies a Job definition id for the set retries action. All failed jobs with that definition id will be updated. Note: Only one method of referencing jobs is allowed. If you use jobDefinitionId, you can not use jobId or jobId.
      Parameters:
      jobDefinitionId - the job definition id. Must not be null or empty ("").
      Returns:
      the builder instance
      See Also:

    • dueDate

      SetJobRetriesBuilder dueDate(Date dueDate)
      Specifies a due date to be set on the referenced jobs. When the number of retries of a job are incremented it is not automatically scheduled for immediate execution. When a Job is executed is determined by the due date. By setting the due date together with the job retries, the scheduled execution date of the job can be adjusted.
      Parameters:
      dueDate - The new due date for the updated jobs. If it is null, the due date will be set to null. If ensureJobDueDateNotNull is true, the due date will be set to the current date instead of null.
      Returns:
      the builder instance

    • execute

      void execute()
      Closes the fluent builder and executes the instructions.
      Throws:
      ProcessEngineException - Check the builder methods and their linked counterparts in ManagementService for more detail