Package io.jenkins.plugins.checks.api

Class ChecksOutput.ChecksOutputBuilder

java.lang.Object

io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder

Enclosing class:

ChecksOutput

public static class ChecksOutput.ChecksOutputBuilder
extends Object

Builder for ChecksOutput.

Constructor Summary

Constructors

Constructor	Description
ChecksOutputBuilder()	Construct a builder for a ChecksOutput.

Method Summary

Modifier and Type	Method	Description
ChecksOutput.ChecksOutputBuilder	addAnnotation(ChecksAnnotation annotation)	Adds a ChecksAnnotation.
ChecksOutput.ChecksOutputBuilder	addImage(ChecksImage image)	Adds a ChecksImage.
ChecksOutput	build()	Actually builds the ChecksOutput with given parameters.
ChecksOutput.ChecksOutputBuilder	withAnnotations(List<ChecksAnnotation> annotations)	Sets the ChecksAnnotation for a check run.
ChecksOutput.ChecksOutputBuilder	withImages(List<ChecksImage> images)	Sets the ChecksImage for a check run.
ChecksOutput.ChecksOutputBuilder	withSummary(TruncatedString summary)	Sets the summary of the check run, using a TruncatedString.
ChecksOutput.ChecksOutputBuilder	withSummary(String summary)	Sets the summary of the check run
ChecksOutput.ChecksOutputBuilder	withText(TruncatedString text)	Adds the details description for a check run, using a TruncatedString.
ChecksOutput.ChecksOutputBuilder	withText(String text)	Adds the details description for a check run.
ChecksOutput.ChecksOutputBuilder	withTitle(String title)	Sets the title of the check run.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksOutputBuilder

public ChecksOutputBuilder()

Construct a builder for a ChecksOutput.

Method Detail

withTitle

public ChecksOutput.ChecksOutputBuilder withTitle(String title)

Sets the title of the check run.

Parameters:

title - the title of the check run

Returns:

this builder

withSummary

public ChecksOutput.ChecksOutputBuilder withSummary(String summary)

Sets the summary of the check run

Note that for the GitHub check runs, the summary supports Markdown.

Parameters:

summary - the summary of the check run

Returns:

this builder

withSummary

public ChecksOutput.ChecksOutputBuilder withSummary(TruncatedString summary)

Sets the summary of the check run, using a TruncatedString.

Note that for the GitHub check runs, the summary supports Markdown.

Parameters:

summary - the summary of the check run as a TruncatedString

Returns:

this builder

withText

public ChecksOutput.ChecksOutputBuilder withText(String text)

Adds the details description for a check run. This parameter supports Markdown.

Note that for a GitHub check run, the text supports Markdown.

Parameters:

text - the details description in Markdown

Returns:

this builder

withText

public ChecksOutput.ChecksOutputBuilder withText(TruncatedString text)

Adds the details description for a check run, using a TruncatedString. This parameter supports Markdown.

Note that for a GitHub check run, the text supports Markdown.

Parameters:

text - the details description in Markdown as a TruncatedString

Returns:

this builder

withAnnotations

public ChecksOutput.ChecksOutputBuilder withAnnotations(List<ChecksAnnotation> annotations)

Sets the ChecksAnnotation for a check run.

Parameters:

annotations - the annotations list

Returns:

this builder

addAnnotation

public ChecksOutput.ChecksOutputBuilder addAnnotation(ChecksAnnotation annotation)

Adds a ChecksAnnotation.

Parameters:

annotation - the annotation

Returns:

this builder

withImages

public ChecksOutput.ChecksOutputBuilder withImages(List<ChecksImage> images)

Sets the ChecksImage for a check run.

Parameters:

images - the images list

Returns:

this builder

addImage

public ChecksOutput.ChecksOutputBuilder addImage(ChecksImage image)

Adds a ChecksImage.

Parameters:

image - the image

Returns:

this builder

build

public ChecksOutput build()

Actually builds the ChecksOutput with given parameters.

Returns:

the built ChecksOutput