Package org.kohsuke.github

Class GHCheckRunBuilder

java.lang.Object

org.kohsuke.github.GHCheckRunBuilder

@Preview(ANTIOPE)
public final class GHCheckRunBuilder
extends Object

Drafts or updates a check run.

See Also:

GHCheckRun, GHRepository.createCheckRun(java.lang.String, java.lang.String), documentation, GHCheckRun.update(), documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHCheckRunBuilder.Action
static class	GHCheckRunBuilder.Annotation
static class	GHCheckRunBuilder.Image
static class	GHCheckRunBuilder.Output

Field Summary

Fields

Modifier and Type	Field	Description
protected GHRepository	repo
protected org.kohsuke.github.Requester	requester

Method Summary

Modifier and Type	Method	Description
GHCheckRunBuilder	add(GHCheckRunBuilder.Action action)
GHCheckRunBuilder	add(GHCheckRunBuilder.Output output)
GHCheckRun	create()	Actually creates the check run.
GHCheckRunBuilder	withCompletedAt(Date completedAt)
GHCheckRunBuilder	withConclusion(GHCheckRun.Conclusion conclusion)
GHCheckRunBuilder	withDetailsURL(String detailsURL)
GHCheckRunBuilder	withExternalID(String externalID)
GHCheckRunBuilder	withStartedAt(Date startedAt)
GHCheckRunBuilder	withStatus(GHCheckRun.Status status)

Methods inherited from class java.lang.Object

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

Field Detail

repo

protected final GHRepository repo

requester

protected final org.kohsuke.github.Requester requester

Method Detail

withDetailsURL

@NonNull
public GHCheckRunBuilder withDetailsURL(@CheckForNull
                                        String detailsURL)

withExternalID

@NonNull
public GHCheckRunBuilder withExternalID(@CheckForNull
                                        String externalID)

withStatus

@NonNull
public GHCheckRunBuilder withStatus(@CheckForNull
                                    GHCheckRun.Status status)

withConclusion

@NonNull
public GHCheckRunBuilder withConclusion(@CheckForNull
                                        GHCheckRun.Conclusion conclusion)

withStartedAt

@NonNull
public GHCheckRunBuilder withStartedAt(@CheckForNull
                                       Date startedAt)

withCompletedAt

@NonNull
public GHCheckRunBuilder withCompletedAt(@CheckForNull
                                         Date completedAt)

add

@NonNull
public GHCheckRunBuilder add(@NonNull
                             GHCheckRunBuilder.Output output)

add

@NonNull
public GHCheckRunBuilder add(@NonNull
                             GHCheckRunBuilder.Action action)

create

@NonNull
public GHCheckRun create()
                  throws IOException

Actually creates the check run. (If more than fifty annotations were requested, this is done in batches.)

Returns:

the resulting run

Throws:

IOException - for the usual reasons