Package com.spotify.github.v3.checks
Interface CheckRunOutput
-
- All Known Implementing Classes:
ImmutableCheckRunOutput
@Immutable public interface CheckRunOutput
The interface Check run output. Includes all the details in the report- See Also:
- "https://developer.github.com/v3/checks/runs/#parameters"
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description List<Annotation>
annotations()
Adds information from your analysis to specific lines of code.Optional<Integer>
annotationsCount()
The count of annotations.Optional<String>
annotationsUrl()
Annotations URL, used on response objects.default void
check()
Automatically validates the maximum length of properties.List<CheckRunImage>
images()
Adds images to the output displayed in the GitHub pull request UI.Optional<String>
summary()
The summary of the check run.Optional<String>
text()
The details of the check run.Optional<String>
title()
The title of the check run.
-
-
-
Method Detail
-
summary
Optional<String> summary()
The summary of the check run. This parameter supports Markdown.- Returns:
- the optional
-
text
Optional<String> text()
The details of the check run. This parameter supports Markdown.- Returns:
- the optional
-
images
List<CheckRunImage> images()
Adds images to the output displayed in the GitHub pull request UI.- Returns:
- the list
-
annotations
List<Annotation> annotations()
Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request.- Returns:
- the list
-
annotationsCount
Optional<Integer> annotationsCount()
The count of annotations. Used on response objects.- Returns:
- the optional
-
annotationsUrl
Optional<String> annotationsUrl()
Annotations URL, used on response objects.- Returns:
- the optional
-
check
@Check default void check()
Automatically validates the maximum length of properties.GitHub does not validate these properly on their side (at least in GHE 3.2) and returns 422 HTTP responses instead. To avoid that, let's validate the data in this client library.
-
-