org.mozilla.taskcluster.client.pulse

Class Pulse

java.lang.Object

org.mozilla.taskcluster.client.TaskClusterRequestHandler

org.mozilla.taskcluster.client.pulse.Pulse

public class Pulse
extends TaskClusterRequestHandler

The taskcluster-pulse service, typically available at pulse.taskcluster.net manages pulse credentials for taskcluster users.

A service to manage Pulse credentials for anything using Taskcluster credentials. This allows us self-service and greater control within the Taskcluster project.

See Also:

Pulse API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CallSummary<NamespaceCreationRequest,NamespaceCreationResponse>	createNamespace(String namespace, NamespaceCreationRequest payload) Creates a namespace, given the taskcluster credentials with scopes.
CallSummary<EmptyPayload,Exchange[]>	exchanges() A list of exchanges in the rabbit cluster
CallSummary<EmptyPayload,EmptyPayload>	namespace(String namespace) Gets a namespace, given the taskcluster credentials with scopes.
CallSummary<EmptyPayload,RabbitOverviewResponse>	overview() An overview of the Rabbit cluster
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

Pulse

public Pulse(Credentials credentials)

Pulse

public Pulse(Credentials credentials,
             String baseURL)

Pulse

public Pulse(String clientId,
             String accessToken)

Pulse

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

Pulse

public Pulse(String baseURL)

Pulse

public Pulse()

Method Detail

overview

public CallSummary<EmptyPayload,RabbitOverviewResponse> overview()
                                                          throws APICallFailure

An overview of the Rabbit cluster

Throws:

APICallFailure

See Also:

Rabbit Overview API Documentation

exchanges

public CallSummary<EmptyPayload,Exchange[]> exchanges()
                                               throws APICallFailure

A list of exchanges in the rabbit cluster

Throws:

APICallFailure

See Also:

Rabbit Exchanges API Documentation

createNamespace

public CallSummary<NamespaceCreationRequest,NamespaceCreationResponse> createNamespace(String namespace,
                                                                                       NamespaceCreationRequest payload)
                                                                                throws APICallFailure

Creates a namespace, given the taskcluster credentials with scopes.

Required scopes:

• pulse:namespace:<namespace>

Throws:

APICallFailure

See Also:

Create a namespace API Documentation

namespace

public CallSummary<EmptyPayload,EmptyPayload> namespace(String namespace)
                                                 throws APICallFailure

Gets a namespace, given the taskcluster credentials with scopes.

Required scopes:

• pulse:namespace:<namespace>

Throws:

APICallFailure

See Also:

Get namespace information 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