org.mozilla.taskcluster.client.github

Class Github

java.lang.Object

org.mozilla.taskcluster.client.TaskClusterRequestHandler

org.mozilla.taskcluster.client.github.Github

public class Github
extends TaskClusterRequestHandler

The github service, typically available at github.taskcluster.net, is responsible for publishing pulse messages in response to GitHub events.

This document describes the API end-point for consuming GitHub web hooks

See Also:

Github API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Github()
Github(Credentials credentials)
Github(Credentials credentials, String baseURL)
Github(String baseURL)
Github(String clientId, String accessToken)
Github(String clientId, String accessToken, String certificate)

Method Summary

Modifier and Type	Method and Description
CallSummary<EmptyPayload,EmptyPayload>	badge(String owner, String repo, String branch) Checks the status of the latest build of a given branch and returns corresponding badge image.
CallSummary<EmptyPayload,Builds>	builds() A paginated list of builds that have been run in Taskcluster.
CallSummary<EmptyPayload,EmptyPayload>	githubWebHookConsumer() Capture a GitHub event and publish it via pulse, if it’s a push, release or pull request.
CallSummary<EmptyPayload,IsInstalledFor>	isInstalledFor(String owner, String repo) Checks if the integration has been installed for a given repository of a given organization or user.
CallSummary<EmptyPayload,EmptyPayload>	ping() Respond without doing anything.

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler

apiCall, setBaseURL, uriEncode

Methods inherited from class java.lang.Object

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

Field Detail

defaultBaseURL

protected static final String defaultBaseURL

See Also:

Constant Field Values

Constructor Detail

Github

public Github(Credentials credentials)

Github

public Github(Credentials credentials,
              String baseURL)

Github

public Github(String clientId,
              String accessToken)

Github

public Github(String clientId,
              String accessToken,
              String certificate)

Github

public Github(String baseURL)

Github

public Github()

Method Detail

githubWebHookConsumer

public CallSummary<EmptyPayload,EmptyPayload> githubWebHookConsumer()
                                                             throws APICallFailure

Capture a GitHub event and publish it via pulse, if it’s a push, release or pull request.

Throws:

APICallFailure

See Also:

Consume GitHub WebHook API Documentation

builds

public CallSummary<EmptyPayload,Builds> builds()
                                        throws APICallFailure

A paginated list of builds that have been run in Taskcluster. Can be filtered on various git-specific fields.

Throws:

APICallFailure

See Also:

List of Builds API Documentation

badge

public CallSummary<EmptyPayload,EmptyPayload> badge(String owner,
                                                    String repo,
                                                    String branch)
                                             throws APICallFailure

Checks the status of the latest build of a given branch and returns corresponding badge image.

Throws:

APICallFailure

See Also:

Latest Build Status Badge API Documentation

isInstalledFor

public CallSummary<EmptyPayload,IsInstalledFor> isInstalledFor(String owner,
                                                               String repo)
                                                        throws APICallFailure

Checks if the integration has been installed for a given repository of a given organization or user.

Throws:

APICallFailure

See Also:

Check if Repository has Integration API Documentation

ping

public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure

Respond without doing anything. This endpoint is used to check that the service is up.

Throws:

APICallFailure

See Also:

Ping Server API Documentation