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	The Class Action.
static class	GHCheckRunBuilder.Annotation	The Class Annotation.
static class	GHCheckRunBuilder.Image	The Class Image.
static class	GHCheckRunBuilder.Output	The Class Output.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
GHCheckRunBuilder	add(GHCheckRunBuilder.Action action)	Adds the.
GHCheckRunBuilder	add(GHCheckRunBuilder.Output output)	Adds the.
GHCheckRun	create()	Actually creates the check run.
GHCheckRunBuilder	withCompletedAt(Date completedAt)	With completed at.
GHCheckRunBuilder	withConclusion(GHCheckRun.Conclusion conclusion)	With conclusion.
GHCheckRunBuilder	withDetailsURL(String detailsURL)	With details URL.
GHCheckRunBuilder	withExternalID(String externalID)	With external ID.
GHCheckRunBuilder	withStartedAt(Date startedAt)	With started at.
GHCheckRunBuilder	withStatus(GHCheckRun.Status status)	With 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

The repo.

requester

protected final org.kohsuke.github.Requester requester

The requester.

Method Detail

withDetailsURL

@NonNull
public GHCheckRunBuilder withDetailsURL(@CheckForNull
                                        String detailsURL)

With details URL.

Parameters:

detailsURL - the details URL

Returns:

the GH check run builder

withExternalID

@NonNull
public GHCheckRunBuilder withExternalID(@CheckForNull
                                        String externalID)

With external ID.

Parameters:

externalID - the external ID

Returns:

the GH check run builder

withStatus

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

With status.

Parameters:

status - the status

Returns:

the GH check run builder

withConclusion

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

With conclusion.

Parameters:

conclusion - the conclusion

Returns:

the GH check run builder

withStartedAt

@NonNull
public GHCheckRunBuilder withStartedAt(@CheckForNull
                                       Date startedAt)

With started at.

Parameters:

startedAt - the started at

Returns:

the GH check run builder

withCompletedAt

@NonNull
public GHCheckRunBuilder withCompletedAt(@CheckForNull
                                         Date completedAt)

With completed at.

Parameters:

completedAt - the completed at

Returns:

the GH check run builder

add

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

Adds the.

Parameters:

output - the output

Returns:

the GH check run builder

add

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

Adds the.

Parameters:

action - the action

Returns:

the GH check run builder

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