Package io.jenkins.plugins.checks.status

Class AbstractStatusChecksProperties

java.lang.Object
io.jenkins.plugins.checks.status.AbstractStatusChecksProperties
All Implemented Interfaces:
ExtensionPoint
public abstract class AbstractStatusChecksProperties extends Object implements ExtensionPoint
Extension points for implementations to provide status checks properties. When no implementations is provided for a job, a DefaultStatusCheckProperties will be used.

  • Constructor Details

    • AbstractStatusChecksProperties

      public AbstractStatusChecksProperties()

  • Method Details

    • isApplicable

      public abstract boolean isApplicable(Job<?,?> job)
      Returns whether the implementation is applicable for the job.
      Parameters:
      job - A jenkins job.
      Returns:
      true if applicable

    • getName

      public abstract String getName(Job<?,?> job)
      Returns the name of the status check.
      Parameters:
      job - A jenkins job.
      Returns:
      the name of the status check

    • isSkipped

      public abstract boolean isSkipped(Job<?,?> job)
      Returns whether to skip publishing status checks.
      Parameters:
      job - A jenkins job.
      Returns:
      true if skip

    • isUnstableBuildNeutral

      public boolean isUnstableBuildNeutral(Job<?,?> job)
      Whether to conclude an unstable build as ChecksConclusion.NEUTRAL, else it would be concluded as ChecksConclusion.FAILURE; the default is false.
      Parameters:
      job - A jenkins job.
      Returns:
      false to treat a unstable build as failure.

    • isSuppressLogs

      public boolean isSuppressLogs(Job<?,?> job)
      Returns whether to suppress log output in the FlowExecutionAnalyzer.
      Parameters:
      job - A jenkins job.
      Returns:
      true if logs should be suppressed from checks output.

    • isSkipProgressUpdates

      public boolean isSkipProgressUpdates(Job<?,?> job)
      Returns whether to suppress progress updates from the FlowExecutionAnalyzer. Queued, Checkout and Completed will still run but not 'onNewHead'
      Parameters:
      job - A jenkins job.
      Returns:
      true if progress updates should be skipped.