Package com.spotify.github.v3.clients
Class ChecksClient
- java.lang.Object
-
- com.spotify.github.v3.clients.ChecksClient
-
public class ChecksClient extends Object
Checks API client
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompletableFuture<CheckRunResponse>
createCheckRun(CheckRunRequest checkRun)
Create a checkRun.CompletableFuture<CheckRunResponse>
getCheckRun(long id)
Gets a checkRun by id.CompletableFuture<CheckRunResponseList>
getCheckRuns(String ref)
List checkRuns for a given ref.CompletableFuture<CheckSuite>
getCheckSuite(String id)
Gets a checkRun by id.CompletableFuture<CheckSuiteResponseList>
getCheckSuites(String sha)
List checkSuites for a given ref.CompletableFuture<CheckRunResponse>
updateCheckRun(long id, CheckRunRequest checkRun)
Updates a checkRun.
-
-
-
Method Detail
-
createCheckRun
public CompletableFuture<CheckRunResponse> createCheckRun(CheckRunRequest checkRun)
Create a checkRun.- Parameters:
checkRun
- the checkRunRequest payload to be created- Returns:
- the CheckRunResponse
-
updateCheckRun
public CompletableFuture<CheckRunResponse> updateCheckRun(long id, CheckRunRequest checkRun)
Updates a checkRun.- Parameters:
id
- the checkRun idcheckRun
- the checkRun payload- Returns:
- the completable future
-
getCheckRun
public CompletableFuture<CheckRunResponse> getCheckRun(long id)
Gets a checkRun by id.- Parameters:
id
- the checkRun id- Returns:
- a CheckRunResponse
-
getCheckRuns
public CompletableFuture<CheckRunResponseList> getCheckRuns(String ref)
List checkRuns for a given ref.- Parameters:
ref
- the ref- Returns:
- a list of CheckRun
-
getCheckSuite
public CompletableFuture<CheckSuite> getCheckSuite(String id)
Gets a checkRun by id.- Parameters:
id
- the checkSuite id- Returns:
- a CheckSuite
-
getCheckSuites
public CompletableFuture<CheckSuiteResponseList> getCheckSuites(String sha)
List checkSuites for a given ref.- Parameters:
sha
- the sha- Returns:
- a list of CheckSuite
-
-