buildless-plugin-gradle/build.less.plugin.gradle/BuildlessExtension

BuildlessExtension

abstract class BuildlessExtension @Inject constructor(factory: ObjectFactory) : BuildlessExtensionAPI<Settings, BuildlessSettings> (source)

Buildless for Gradle: Extension

The extension for the Buildless plugin is used from the settings.gradle.kts script to configure the plugin's behavior and features.

Parameters

factory

Object factory for Gradle-provided injection.

See also

BuildlessExtensionAPI

For the public API suite supported by this plugin for configuration of build caching.

BuildlessService

For a service which may be consumed from other plugins to interact with Buildless.

Constructors

BuildlessExtension

@Inject

constructor(factory: ObjectFactory)

Types

object Companion

Constants associated with the Buildless extension.

LocalAgentSetup

inner class LocalAgentSetup : MutableAgentCacheSettings

Mutable settings class for local agent cache settings.

LocalCacheSetup

inner class LocalCacheSetup : MutableLocalCacheSettings

Mutable settings class for local build cache settings.

RemoteCacheSetup

inner class RemoteCacheSetup : MutableRemoteCacheSettings

Mutable settings class for remote build cache settings.

Properties

open override val agent: MutableAgentCacheSettings

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.

open override val apiKey: Property<ApiKey?>

API key to install.

open override val cloud: MutableRemoteCacheSettings

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.

open override val debug: Property<Boolean>

Whether to enable debug mode.

open override val local: MutableLocalCacheSettings

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.

open val localCache: MutableLocalCacheSettings

Alias for local cache settings.

open val remoteCache: MutableRemoteCacheSettings

Alias for cloud remote cache settings.

open override val reportErrors: Property<Boolean>

Whether to enable error reporting.

open override val telemetry: Property<Boolean>

Whether to enable telemetry integration.

open override val transport: Property<CacheTransport>

Cache transport to use.

Functions

open override fun agent(config: MutableAgentCacheSettings.() -> Unit)

Configure agent caching settings with the provided config function.

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.

open override fun config(context: Settings, configure: BuildlessSettings.() -> Unit)

Main configuration entrypoint for the extension implementing this interface; not meant to be used by end-user code.

open override fun localCache(config: MutableLocalCacheSettings.() -> Unit)

Configure local caching settings with the provided config function.

open override fun remoteCache(config: MutableRemoteCacheSettings.() -> Unit)

Configure remote caching settings with the provided config function.