api / org.gradle.caching / BuildCacheServiceFactory

BuildCacheServiceFactory

@Incubating interface BuildCacheServiceFactory<T : BuildCache>

Factory interface to be provided by build cache service implementations.

To be able to use a BuildCacheService, the factory that implements this interface and the configuration type (BuildCache) must be registered with the org.gradle.caching.configuration.BuildCacheConfiguration.

In settings.gradle:

 buildCache { // Register custom build cache implementation registerBuildCacheService(CustomBuildCache, CustomBuildCacheFactory) remote(CustomBuildCache) { // configure custom build cache. } } 

Parameters

- the type of build cache configuration this factory can handle.

Since
3.5

Types

Describer

interface Describer

Builder-style object that allows build cache service factories to describe the cache service.

The description is for human consumption. It may be logged and displayed by tooling.

Functions

createBuildCacheService

abstract fun createBuildCacheService(configuration: T, describer: Describer): BuildCacheService

Creates a build cache service from the given configuration. Implementations should also provide a description via the given describer.