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 for self-service pulse access 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>	claimNamespace(String namespace, NamespaceCreationRequest payload) Claim a namespace, returning a username and password with access to that namespace good for a short time.
CallSummary<EmptyPayload,ListNamespacesResponse>	listNamespaces() List the namespaces managed by this service.
CallSummary<EmptyPayload,Namespace>	namespace(String namespace) Get public information about a single namespace.
CallSummary<EmptyPayload,RabbitOverviewResponse>	overview() Get 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

Get an overview of the Rabbit cluster.

Throws:

APICallFailure

See Also:

Rabbit Overview API Documentation

listNamespaces

public CallSummary<EmptyPayload,ListNamespacesResponse> listNamespaces()
                                                                throws APICallFailure

List the namespaces managed by this service.

This will list up to 1000 namespaces. If more namespaces are present a continuationToken will be returned, which can be given in the next request. For the initial request, do not provide continuation.

Throws:

APICallFailure

See Also:

List Namespaces API Documentation

namespace

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

Get public information about a single namespace. This is the same information as returned by listNamespaces.

Throws:

APICallFailure

See Also:

Get a namespace API Documentation

claimNamespace

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

Claim a namespace, returning a username and password with access to that namespace good for a short time. Clients should call this endpoint again at the re-claim time given in the response, as the password will be rotated soon after that time. The namespace will expire, and any associated queues and exchanges will be deleted, at the given expiration time.

The expires and contact properties can be updated at any time in a reclaim operation.

Required scopes: pulse:namespace:

Throws:

APICallFailure

See Also:

Claim a namespace 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