Package io.jenkins.plugins.checks.api

Class ChecksDetails.ChecksDetailsBuilder

java.lang.Object

io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder

Enclosing class:

ChecksDetails

public static class ChecksDetails.ChecksDetailsBuilder
extends Object

Builder for ChecksDetails.

Constructor Summary

Constructors

Constructor	Description
ChecksDetailsBuilder()	Construct a builder for ChecksDetails.

Method Summary

Modifier and Type	Method	Description
ChecksDetails.ChecksDetailsBuilder	addAction(ChecksAction action)	Adds a ChecksAction.
ChecksDetails	build()	Actually build the ChecksDetail.
ChecksDetails.ChecksDetailsBuilder	withActions(List<ChecksAction> actions)	Set the actions of a check.
ChecksDetails.ChecksDetailsBuilder	withCompletedAt(LocalDateTime completedAt)	Set the time when a check completes.
ChecksDetails.ChecksDetailsBuilder	withConclusion(ChecksConclusion conclusion)	Set the conclusion of a check.
ChecksDetails.ChecksDetailsBuilder	withDetailsURL(String detailsURL)	Set the url of a site with full details of a check.
ChecksDetails.ChecksDetailsBuilder	withName(String name)	Set the name of the check.
ChecksDetails.ChecksDetailsBuilder	withOutput(ChecksOutput output)	Set the output of a check.
ChecksDetails.ChecksDetailsBuilder	withStartedAt(LocalDateTime startedAt)	Set the time when a check starts.
ChecksDetails.ChecksDetailsBuilder	withStatus(ChecksStatus status)	Set the status of the check.

Methods inherited from class java.lang.Object

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

Constructor Details

ChecksDetailsBuilder

public ChecksDetailsBuilder()

Construct a builder for ChecksDetails.

Method Details

withName

public ChecksDetails.ChecksDetailsBuilder withName(String name)

Set the name of the check.

Note that for GitHub check runs, the name shown on GitHub UI will be the same as this attribute and GitHub uses this attribute to identify a check run, so make sure this name is unique, e.g. "Coverage".

Parameters:

name - the check's name

Returns:

this builder

Throws:

NullPointerException - if the name is null

withStatus

public ChecksDetails.ChecksDetailsBuilder withStatus(ChecksStatus status)

Set the status of the check.

Note that for a GitHub check run, if the status is not set, the default "queued" will be used.

Parameters:

status - the check's status

Returns:

this builder

Throws:

NullPointerException - if the status is null

withDetailsURL

public ChecksDetails.ChecksDetailsBuilder withDetailsURL(String detailsURL)

Set the url of a site with full details of a check.

Note that for a GitHub check run, the url must use http or https scheme.

If the details url is not set, the Jenkins build url will be used, e.g. https://ci.jenkins.io/job/Core/job/jenkins/job/master/2000/.

Parameters:

detailsURL - the url using http or https scheme

Returns:

this builder

Throws:

NullPointerException - if the detailsURL is null

withStartedAt

public ChecksDetails.ChecksDetailsBuilder withStartedAt(LocalDateTime startedAt)

Set the time when a check starts.

Parameters:

startedAt - the time when a check starts

Returns:

this builder

Throws:

NullPointerException - if the startAt is null

withConclusion

public ChecksDetails.ChecksDetailsBuilder withConclusion(ChecksConclusion conclusion)

Set the conclusion of a check.

Note that for a GitHub check run, the conclusion should only be set when the status was ChecksStatus.COMPLETED.

Parameters:

conclusion - the conclusion

Returns:

this builder

Throws:

NullPointerException - if the conclusion is null

withCompletedAt

public ChecksDetails.ChecksDetailsBuilder withCompletedAt(LocalDateTime completedAt)

Set the time when a check completes.

Parameters:

completedAt - the time when a check completes

Returns:

this builder

Throws:

NullPointerException - if the completedAt is null

withOutput

public ChecksDetails.ChecksDetailsBuilder withOutput(ChecksOutput output)

Set the output of a check.

Parameters:

output - an output of a check

Returns:

this builder

Throws:

NullPointerException - if the outputs is null

withActions

public ChecksDetails.ChecksDetailsBuilder withActions(List<ChecksAction> actions)

Set the actions of a check.

Parameters:

actions - a list of actions

Returns:

this builder

Throws:

NullPointerException - if the actions is null

addAction

public ChecksDetails.ChecksDetailsBuilder addAction(ChecksAction action)

Adds a ChecksAction.

Parameters:

action - the action

Returns:

this builder

build

public ChecksDetails build()

Actually build the ChecksDetail.

Returns:

the built ChecksDetail