Package org.gradle.caching.configuration
Interface BuildCacheConfiguration
public interface BuildCacheConfiguration
Configuration for the build cache for an entire Gradle build.
- Since:
- 3.5
- 
Method SummaryModifier and TypeMethodDescriptiongetLocal()Returns the local directory cache configuration.Returns the remote cache configuration.voidlocal(Action<? super DirectoryBuildCache> configuration) Executes the given action against the local configuration.<T extends BuildCache>
 voidregisterBuildCacheService(Class<T> configurationType, Class<? extends BuildCacheServiceFactory<? super T>> buildCacheServiceFactoryType) Registers a custom build cache type.<T extends BuildCache>
 TConfigures a remote cache with the given type.<T extends BuildCache>
 TConfigures a remote cache with the given type.voidremote(Action<? super BuildCache> configuration) Executes the given action against the currently configured remote cache.
- 
Method Details- 
registerBuildCacheService<T extends BuildCache> void registerBuildCacheService(Class<T> configurationType, Class<? extends BuildCacheServiceFactory<? super T>> buildCacheServiceFactoryType) Registers a custom build cache type.- Parameters:
- configurationType- Configuration type used to provide parameters to a- BuildCacheService
- buildCacheServiceFactoryType- Implementation type of- BuildCacheServiceFactorythat is used to create a- BuildCacheService
 
- 
getLocalDirectoryBuildCache getLocal()Returns the local directory cache configuration.
- 
localExecutes the given action against the local configuration.- Parameters:
- configuration- the action to execute against the local cache configuration.
 
- 
getRemoteReturns the remote cache configuration.
- 
remoteConfigures a remote cache with the given type.If a remote build cache has already been configured with a different type, this method replaces it. Storing ("push") in the remote build cache is disabled by default. - Parameters:
- type- the type of remote cache to configure.
 
- 
remoteConfigures a remote cache with the given type.If a remote build cache has already been configured with a different type, this method replaces it. If a remote build cache has already been configured with the same, this method configures it. Storing ("push") in the remote build cache is disabled by default. - Parameters:
- type- the type of remote cache to configure.
- configuration- the configuration to execute against the remote cache.
 
- 
remoteExecutes the given action against the currently configured remote cache.- Parameters:
- configuration- the action to execute against the currently configured remote cache.
- Throws:
- IllegalStateException- If no remote cache has been assigned yet
 
 
-