Package io.jenkins.plugins.checks.api

Class ChecksOutput

java.lang.Object
io.jenkins.plugins.checks.api.ChecksOutput
public class ChecksOutput extends Object
An output of a check. The output usually contains the most useful information like summary, description, annotations, etc.

  • Constructor Details

    • ChecksOutput

      public ChecksOutput(ChecksOutput that)
      Copy constructor of the ChecksOutput.
      Parameters:
      that - the source to copy from

  • Method Details

    • getTitle

      public Optional<String> getTitle()

    • getSummary

      public Optional<String> getSummary()

    • getSummary

      public Optional<String> getSummary(int maxSize)
      Get the output summary, truncated by TruncatedString to maxSize.
      Parameters:
      maxSize - maximum size to truncate summary to.
      Returns:
      Summary, truncated to maxSize with truncation message if appropriate.

    • getText

      public Optional<String> getText()

    • getText

      public Optional<String> getText(int maxSize)
      Get the output text, truncated by TruncatedString to maxSize.
      Parameters:
      maxSize - maximum size to truncate text to.
      Returns:
      Text, truncated to maxSize with truncation message if appropriate.

    • getChecksAnnotations

      public List<ChecksAnnotation> getChecksAnnotations()

    • getChecksImages

      public List<ChecksImage> getChecksImages()

    • toString

      public String toString()
      Overrides:
      toString in class Object