Package io.jenkins.plugins.checks.api
Class ChecksDetails
- java.lang.Object
-
- io.jenkins.plugins.checks.api.ChecksDetails
-
public class ChecksDetails extends Object
Details of a check. This class is a top class which contains all parameters needed for a check.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChecksDetails.ChecksDetailsBuilder
Builder forChecksDetails
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ChecksAction>
getActions()
Returns theChecksAction
s of a check.Optional<LocalDateTime>
getCompletedAt()
Returns the time that the check completed.ChecksConclusion
getConclusion()
Returns the conclusion of a check.Optional<String>
getDetailsURL()
Returns the url of a site with full details of a check.Optional<String>
getName()
Returns the name of a check.Optional<ChecksOutput>
getOutput()
Returns theChecksOutput
of a check.Optional<LocalDateTime>
getStartedAt()
Returns the time that the check started.ChecksStatus
getStatus()
Returns the status of a check.String
toString()
-
-
-
Method Detail
-
getName
public Optional<String> getName()
Returns the name of a check.- Returns:
- the unique name of a check
-
getStatus
public ChecksStatus getStatus()
Returns the status of a check.- Returns:
ChecksStatus
, one ofQUEUED
,IN_PROGRESS
,COMPLETED
.
-
getDetailsURL
public Optional<String> getDetailsURL()
Returns the url of a site with full details of a check.- Returns:
- the url of a site
-
getStartedAt
public Optional<LocalDateTime> getStartedAt()
Returns the time that the check started.- Returns:
- the start time of a check
-
getConclusion
public ChecksConclusion getConclusion()
Returns the conclusion of a check.- Returns:
- the conclusion of a check
-
getCompletedAt
public Optional<LocalDateTime> getCompletedAt()
Returns the time that the check completed.- Returns:
- the complete time of a check
-
getOutput
public Optional<ChecksOutput> getOutput()
Returns theChecksOutput
of a check.- Returns:
- An
ChecksOutput
of a check
-
getActions
public List<ChecksAction> getActions()
Returns theChecksAction
s of a check.- Returns:
- An immutable list of
ChecksAction
s of a check
-
-