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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChecksOutput.ChecksOutputBuilder
Builder forChecksOutput
.
-
Constructor Summary
Constructors Constructor Description ChecksOutput(ChecksOutput that)
Copy constructor of theChecksOutput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ChecksAnnotation>
getChecksAnnotations()
List<ChecksImage>
getChecksImages()
Optional<String>
getSummary()
Optional<String>
getSummary(int maxSize)
Get the output summary, truncated byTruncatedString
to maxSize.Optional<String>
getText()
Optional<String>
getText(int maxSize)
Get the output text, truncated byTruncatedString
to maxSize.Optional<String>
getTitle()
String
toString()
-
-
-
Constructor Detail
-
ChecksOutput
public ChecksOutput(ChecksOutput that)
Copy constructor of theChecksOutput
.- Parameters:
that
- the source to copy from
-
-
Method Detail
-
getSummary
public Optional<String> getSummary(int maxSize)
Get the output summary, truncated byTruncatedString
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(int maxSize)
Get the output text, truncated byTruncatedString
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()
-
-