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 and Description
static class	ChecksOutput.ChecksOutputBuilder Builder for ChecksOutput.

Constructor Summary

Constructors

Constructor and Description
ChecksOutput(ChecksOutput that) Copy constructor of the ChecksOutput.

Method Summary

Modifier and Type	Method and Description
List<ChecksAnnotation>	getChecksAnnotations()
List<ChecksImage>	getChecksImages()
Optional<String>	getSummary()
Optional<String>	getSummary(int maxSize) Get the output summary, truncated by TruncatedString to maxSize.
Optional<String>	getText()
Optional<String>	getText(int maxSize) Get the output text, truncated by TruncatedString to maxSize.
Optional<String>	getTitle()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChecksOutput

public ChecksOutput(ChecksOutput that)

Copy constructor of the ChecksOutput.

Parameters:

that - the source to copy from

Method Detail

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