Struct taskcluster::PurgeCache
source · pub struct PurgeCache {
pub client: Client,
}
Expand description
Purge Cache Service
The purge-cache service is responsible for tracking cache-purge requests.
User create purge requests for specific caches on specific workers, and these requests are timestamped. Workers consult the service before starting a new task, and purge any caches older than the timestamp.
Fields§
§client: Client
The underlying client used to make API calls for this service.
Implementations§
source§impl PurgeCache
impl PurgeCache
sourcepub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>
pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error>
Create a new PurgeCache instance, based on the given client builder
sourcepub async fn ping(&self) -> Result<(), Error>
pub async fn ping(&self) -> Result<(), Error>
Ping Server
Respond without doing anything. This endpoint is used to check that the service is up.
sourcepub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>
pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error>
Generate a signed URL for the ping endpoint
sourcepub async fn lbheartbeat(&self) -> Result<(), Error>
pub async fn lbheartbeat(&self) -> Result<(), Error>
Load Balancer Heartbeat
Respond without doing anything. This endpoint is used to check that the service is up.
sourcepub fn lbheartbeat_url(&self) -> Result<String, Error>
pub fn lbheartbeat_url(&self) -> Result<String, Error>
Generate an unsigned URL for the lbheartbeat endpoint
sourcepub fn lbheartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>
pub fn lbheartbeat_signed_url(&self, ttl: Duration) -> Result<String, Error>
Generate a signed URL for the lbheartbeat endpoint
sourcepub async fn version(&self) -> Result<(), Error>
pub async fn version(&self) -> Result<(), Error>
Taskcluster Version
Respond with the JSON version object. https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
sourcepub fn version_url(&self) -> Result<String, Error>
pub fn version_url(&self) -> Result<String, Error>
Generate an unsigned URL for the version endpoint
sourcepub fn version_signed_url(&self, ttl: Duration) -> Result<String, Error>
pub fn version_signed_url(&self, ttl: Duration) -> Result<String, Error>
Generate a signed URL for the version endpoint
sourcepub async fn purgeCache(
&self,
workerPoolId: &str,
payload: &Value
) -> Result<(), Error>
pub async fn purgeCache( &self, workerPoolId: &str, payload: &Value ) -> Result<(), Error>
Purge Worker Cache
Publish a request to purge caches named cacheName
with
on workerPoolId
workers.
If such a request already exists, its before
timestamp is updated to
the current time.
sourcepub async fn allPurgeRequests(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<Value, Error>
pub async fn allPurgeRequests( &self, continuationToken: Option<&str>, limit: Option<&str> ) -> Result<Value, Error>
All Open Purge Requests
View all active purge requests.
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.
sourcepub fn allPurgeRequests_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>
) -> Result<String, Error>
pub fn allPurgeRequests_url( &self, continuationToken: Option<&str>, limit: Option<&str> ) -> Result<String, Error>
Generate an unsigned URL for the allPurgeRequests endpoint
sourcepub fn allPurgeRequests_signed_url(
&self,
continuationToken: Option<&str>,
limit: Option<&str>,
ttl: Duration
) -> Result<String, Error>
pub fn allPurgeRequests_signed_url( &self, continuationToken: Option<&str>, limit: Option<&str>, ttl: Duration ) -> Result<String, Error>
Generate a signed URL for the allPurgeRequests endpoint
sourcepub async fn purgeRequests(
&self,
workerPoolId: &str,
since: Option<&str>
) -> Result<Value, Error>
pub async fn purgeRequests( &self, workerPoolId: &str, since: Option<&str> ) -> Result<Value, Error>
Open Purge Requests for a worker pool
List the caches for this workerPoolId
that should to be
purged if they are from before the time given in the response.
This is intended to be used by workers to determine which caches to purge.
sourcepub fn purgeRequests_url(
&self,
workerPoolId: &str,
since: Option<&str>
) -> Result<String, Error>
pub fn purgeRequests_url( &self, workerPoolId: &str, since: Option<&str> ) -> Result<String, Error>
Generate an unsigned URL for the purgeRequests endpoint
sourcepub fn purgeRequests_signed_url(
&self,
workerPoolId: &str,
since: Option<&str>,
ttl: Duration
) -> Result<String, Error>
pub fn purgeRequests_signed_url( &self, workerPoolId: &str, since: Option<&str>, ttl: Duration ) -> Result<String, Error>
Generate a signed URL for the purgeRequests endpoint
sourcepub async fn heartbeat(&self) -> Result<(), Error>
pub async fn heartbeat(&self) -> Result<(), Error>
Heartbeat
Respond with a service heartbeat.
This endpoint is used to check on backing services this service depends on.
sourcepub fn heartbeat_url(&self) -> Result<String, Error>
pub fn heartbeat_url(&self) -> Result<String, Error>
Generate an unsigned URL for the heartbeat endpoint