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

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,EmptyPayload>	ping() Documented later…
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.

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

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.

See https://docs.taskcluster.net/reference/core/purge-cache/api-docs#purgeCache

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/purge-cache/api-docs#ping

Throws:

APICallFailure