Package org.flowable.external.client

Interface ExternalWorkerJobFailureBuilder

All Known Implementing Classes:
RestExternalWorkerFailureBuilder
public interface ExternalWorkerJobFailureBuilder
A builder that can be used to complete a specific job.
Author:
Filip Hrisafov

  • Method Details

    • error

      ExternalWorkerJobFailureBuilder error(Exception exception)
      Provide fail information based on the exception. The Throwable.getMessage() will be used as the failure message and the exception stacktrace will be used as the details.
      Parameters:
      exception - the exception that should be used to provide the message and details
      See Also:

    • message

      ExternalWorkerJobFailureBuilder message(String message)
      The failure message that should be passed to the Flowable application.
      Parameters:
      message - the failure message

    • details

      ExternalWorkerJobFailureBuilder details(String details)
      The failure details that should be passed to the Flowable application.
      Parameters:
      details - the failure details

    • retries

      ExternalWorkerJobFailureBuilder retries(int retries)
      How many times should the job be retried. This can be used to increase / decrease the existing retries of a job. When nothing is set then the Flowable application is going to decrease the retries by 1.
      Parameters:
      retries - the new retry count for the job

    • retryTimeout

      ExternalWorkerJobFailureBuilder retryTimeout(Duration retryTimeout)
      How long should the Flowable application wait before making this job available for execution. This can be used to set a specific period after which the execution of a job would be successful.
      Parameters:
      retryTimeout - the period that the Flowable application should wait before making this job available

    • fail

      void fail()
      Execute the failure of the job.