Package com.almworks.jira.structure.api.process

Interface ProgressGauge

public interface ProgressGauge
A ProgressGauge allows you to communicate with a background process.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Ask the process to stop.
    I18nText
    getActivity()
    Returns a short description of the current activity.
    int
    getPercentComplete()
    Returns process completion percentage, 0 to 100, or -1 if progress is unknown/indeterminate.

  • Method Details

    • getActivity

      I18nText getActivity()
      Returns a short description of the current activity.

    • getPercentComplete

      int getPercentComplete()
      Returns process completion percentage, 0 to 100, or -1 if progress is unknown/indeterminate.

    • cancel

      void cancel()
      Ask the process to stop. It's up to the process to decide what to do about this request.