org.mozilla.taskcluster.client.purgecache

Class PurgeCache

java.lang.Object

org.mozilla.taskcluster.client.TaskclusterRequestHandler

org.mozilla.taskcluster.client.purgecache.PurgeCache

public class PurgeCache
extends TaskclusterRequestHandler

The purge-cache service, typically available at purge-cache.taskcluster.net, is responsible for publishing a pulse message for workers, so they can purge cache upon request.

This document describes the API end-point for publishing the pulse message. This is mainly intended to be used by tools.

See Also:

PurgeCache API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CallSummary<EmptyPayload,OpenAllPurgeRequestsList>	allPurgeRequests() This is useful mostly for administors to view the set of open purge requests.
CallSummary<EmptyPayload,EmptyPayload>	ping() Respond without doing anything.
CallSummary<PurgeCacheRequest,EmptyPayload>	purgeCache(String provisionerId, String workerType, PurgeCacheRequest payload) Publish a purge-cache message to purge caches named cacheName with provisionerId and workerType in the routing-key.
CallSummary<EmptyPayload,OpenPurgeRequestList>	purgeRequests(String provisionerId, String workerType) List of caches that need to be purged if they are from before a certain time.

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

PurgeCache

public PurgeCache(Credentials credentials)

PurgeCache

public PurgeCache(Credentials credentials,
                  String baseURL)

PurgeCache

public PurgeCache(String clientId,
                  String accessToken)

PurgeCache

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

PurgeCache

public PurgeCache(String baseURL)

PurgeCache

public PurgeCache()

Method Detail

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

purgeCache

public CallSummary<PurgeCacheRequest,EmptyPayload> purgeCache(String provisionerId,
                                                              String workerType,
                                                              PurgeCacheRequest payload)
                                                       throws APICallFailure

Publish a purge-cache message to purge caches named cacheName with provisionerId and workerType in the routing-key. Workers should be listening for this message and purge caches when they see it.

Required scopes: purge-cache:/:

Throws:

APICallFailure

See Also:

Purge Worker Cache API Documentation

allPurgeRequests

public CallSummary<EmptyPayload,OpenAllPurgeRequestsList> allPurgeRequests()
                                                                    throws APICallFailure

This is useful mostly for administors to view the set of open purge requests. It should not be used by workers. They should use the purgeRequests endpoint that is specific to their workerType and provisionerId.

Throws:

APICallFailure

See Also:

All Open Purge Requests API Documentation

purgeRequests

public CallSummary<EmptyPayload,OpenPurgeRequestList> purgeRequests(String provisionerId,
                                                                    String workerType)
                                                             throws APICallFailure

List of caches that need to be purged if they are from before a certain time. This is safe to be used in automation from workers.

Throws:

APICallFailure

See Also:

Open Purge Requests for a provisionerId/workerType pair API Documentation