BuildCacheConfiguration

API Documentation:BuildCacheConfiguration

Note: This class is incubating and may change in a future version of Gradle.

Configuration for the build cache for an entire Gradle build.

Properties

PropertyDescription
local
Incubating

The local cache configuration.

remote
Incubating

The remote cache configuration.

Methods

MethodDescription
local(type)
Incubating

Configures the local cache with the given type.

local(type, configuration)
Incubating

Configures the local cache with the given type.

local(configuration)
Incubating

Executes the given action against the local configuration.

remote(type)
Incubating

Configures a remote cache with the given type.

remote(type, configuration)
Incubating

Configures a remote cache with the given type.

remote(configuration)
Incubating

Executes the given action against the currently configured remote cache.

Script blocks

No script blocks

Property details

BuildCache local (read-only)

Note: This property is incubating and may change in a future version of Gradle.

The local cache configuration.

BuildCache remote (read-only)

Note: This property is incubating and may change in a future version of Gradle.

The remote cache configuration.

Method details

T local(Class<T> type)

Note: This method is incubating and may change in a future version of Gradle.

Configures the local cache with the given type.

If a local build cache has already been configured with a different type, this method replaces it.

Push is enabled by default for the local cache.

T local(Class<T> type, Action<? super T> configuration)

Note: This method is incubating and may change in a future version of Gradle.

Configures the local cache with the given type.

If a local build cache has already been configured with a different type, this method replaces it.

If a local build cache has already been configured with the same type, this method configures it.

Push is enabled by default for the local cache.

void local(Action<? super BuildCache> configuration)

Note: This method is incubating and may change in a future version of Gradle.

Executes the given action against the local configuration.

T remote(Class<T> type)

Note: This method is incubating and may change in a future version of Gradle.

Configures a remote cache with the given type.

If a remote build cache has already been configured with a different type, this method replaces it.

Push is disabled by default for the remote cache.

T remote(Class<T> type, Action<? super T> configuration)

Note: This method is incubating and may change in a future version of Gradle.

Configures 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.

Push is disabled by default for the remote cache.

void remote(Action<? super BuildCache> configuration)

Note: This method is incubating and may change in a future version of Gradle.

Executes the given action against the currently configured remote cache.