HttpBuildCache

API Documentation:HttpBuildCache

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

Configuration object for the HTTP build cache. The build cache only supports BASIC authentication currently.

Cache entries are loaded via GET and stored via PUT requests.

For a GET request we expect a 200 or 404 response and for PUT we expect any 2xx response. Other responses are treated as recoverable or non-recoverable errors, depending on the status code. E.g. we treat authentication failures (401 and 409) as non-recoverable while an internal server error (500) is recoverable.

Properties

PropertyDescription
allowUntrustedServer
Incubating

Specifies whether it is acceptable to communicate with an HTTP build cache backend with an untrusted SSL certificate.

enabled
Incubating

Whether the build cache is enabled.

push
Incubating

Whether pushing to the build cache is enabled.

url
Incubating

The URI to the cache.

Methods

MethodDescription
credentials(configuration)
Incubating

Configures the credentials used to access the HTTP cache backend.

Script blocks

No script blocks

Property details

boolean allowUntrustedServer

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

Specifies whether it is acceptable to communicate with an HTTP build cache backend with an untrusted SSL certificate.

The SSL certificate for the HTTP build cache backend may be untrusted since it is internally provisioned or a self-signed certificate.

In such a scenario, you can either configure the build JVM environment to trust the certificate, or set this property to true to disable verification of the server's identity.

Allowing communication with untrusted servers keeps data encrypted during transmission, but makes it easier for a man-in-the-middle to impersonate the intended server and capture data.

This value has no effect if a server is specified using the HTTP protocol (i.e. has SSL disabled).

boolean enabled

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

Whether the build cache is enabled.

boolean push

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

Whether pushing to the build cache is enabled.

URI url

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

The URI to the cache.

Method details

void credentials(Action<? super HttpBuildCacheCredentials> configuration)

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

Configures the credentials used to access the HTTP cache backend.