Package com.xebialabs.xlrelease.api.v1

# Interface CacheManagementApi

@Path("/api/v1/caches") @Consumes("application/json") @Produces("application/json") public interface CacheManagementApi
Operations on caches

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `clearAllCacheGroups()`
  Clears all caches.
  `void`
  `clearCacheGroup(String cacheGroup)`
  Clears all caches for the particular cache group.
  `Map<String,Map<String,String>>`
  `getCacheStatistics(String cacheGroup)`
  Fetches cache statistics for the particular cache group.
  `List<CacheGroupView>`
  `listCacheGroups()`
  Lists available cache groups.

- ## Method Details

  - ### listCacheGroups

    @GET @Path("/groups") List<CacheGroupView> listCacheGroups()
    Lists available cache groups.
    Returns:
      list of cache groups

  - ### clearAllCacheGroups

    @DELETE @Path("/groups") void clearAllCacheGroups()
    Clears all caches.

  - ### clearCacheGroup

    @DELETE @Path("/groups/{cacheGroup}") void clearCacheGroup(@PathParam("cacheGroup") String cacheGroup)
    Clears all caches for the particular cache group.
    Parameters:
      `cacheGroup` - the cache group to clear

  - ### getCacheStatistics

    @GET @Path("/groups/{cacheGroup}/statistics") Map<String,Map<String,String>> getCacheStatistics(@PathParam("cacheGroup") String cacheGroup)
    Fetches cache statistics for the particular cache group.
    Parameters:
      `cacheGroup` - the cache group to fetch statistics for
    Returns:
      cache statistics