BuildlessSettings

interface BuildlessSettings : ConfigAPI<Settings> (source)

Buildless Extension API: Settings

Describes top-level settings which are available within settings.gradle.kts for a Buildless-enabled Gradle project. These settings apply within the scope of file in question (usually, all projects within a multi-project Gradle build, or a single Gradle project).

These settings implement the ConfigAPI interface for a target of Settings, but with mutable fields so that they may be set from a builder context.

See also

for read-only fields shared by all settings payloads provided by the Buildless plugin for Gradle.

Inheritors

Properties

Link copied to clipboard

Specifies agent cache settings for this Gradle project. Agent caching keeps built outputs within a local cache service, like Buildless Agent. Agent caching is enabled by default if an API key is present in the local environment, using the main Gradle cache endpoint.

Link copied to clipboard
abstract val apiKey: Property<ApiKey?>

API key that should be used to identify this project to the Buildless cache service.

Link copied to clipboard

Specifies remote cache settings for this Gradle project. Remote caching keeps built outputs within a remote cache service, like Buildless. Remote caching is enabled by default if an API key is present in the local environment, using the main Gradle cache endpoint.

Link copied to clipboard
abstract override val debug: Property<Boolean>

Specifies whether "debug mode" is active within the Buildless plugin. When debug mode is active, verbose logging is emitted to the terminal, and various trace values are sent to the Buildless API, which can be used to diagnose issues with the cache from the web dashboard.

Link copied to clipboard

Specifies local cache settings for this Gradle project. Local caching keeps various cached objects in a directory on-disk, and objects never leave the developer's machine. Local caching is enabled by default, and generally it is recommended to keep it active.

Link copied to clipboard

Alias for local cache settings.

Link copied to clipboard

Alias for cloud remote cache settings.

Link copied to clipboard
abstract val reportErrors: Property<Boolean>

Specifies whether errors should be reported to the Buildless API. When error reporting is active, errors which are encountered when interacting with the cache are reported to a central service. These logs include only the authorization material provided by the developer, along with light context from the Gradle build.

Link copied to clipboard
abstract val telemetry: Property<Boolean>

Whether to enable telemetry for this build.

Link copied to clipboard
abstract val transport: Property<CacheTransport>

Transport mechanism to use when interacting with the Buildless cache.

Functions

Link copied to clipboard
abstract fun agent(config: MutableAgentCacheSettings.() -> Unit)

Configure agent caching settings with the provided config function.

Link copied to clipboard
open fun apiKey(key: ApiKey)

Set the API key to use when interacting with the Buildless service.

open fun apiKey(value: String)

Set the API key from the provided string value.

Link copied to clipboard
abstract fun localCache(config: MutableLocalCacheSettings.() -> Unit)

Configure local caching settings with the provided config function.

Link copied to clipboard
abstract fun remoteCache(config: MutableRemoteCacheSettings.() -> Unit)

Configure remote caching settings with the provided config function.