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: https://docs.taskcluster.net/reference/core/github/api-docs

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>	githubWebHookConsumer() Capture a GitHub event and publish it via pulse, if it’s a push or pull request.
CallSummary<EmptyPayload,EmptyPayload>	ping() Documented later…

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 or pull request.

See https://docs.taskcluster.net/reference/core/github/api-docs#githubWebHookConsumer

Throws:

APICallFailure

ping

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

Documented later…

Warning this api end-point is not stable.

See https://docs.taskcluster.net/reference/core/github/api-docs#ping

Throws:

APICallFailure