buildless-plugin-gradle/build.less.plugin.gradle/BuildlessSettings/apiKey

apiKey

open fun apiKey(value: String)(source)

Set the API key from the provided string value.

Return

Checked API key value.

Parameters

value

API key value to use.

Throws

if the provided key value is found to be malformed.

open fun apiKey(key: ApiKey)(source)

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

This interface accepts a key which has already been checked for use. For a full description of how API keys are resolved and loaded, see the apiKey field.

Parameters

key

API key to use (pre-checked).

abstract val apiKey: Property<ApiKey?>(source)

API Key

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

API keys can be obtained from the Buildless Dashboard (see Buildless for more information). Every tenant and user is issued two API keys: their "events" key (also referred to as the PUBLISHABLE key), and their own regular user access key.

The access key is the value which should be specified in this spot. Additionally, the key may be provided via any of the following mechanisms:

  • Environment variables (BUILDLESS_API_KEY, GRADLE_CACHE_PASSWORD)

  • System properties (buildless.apiKey, cachePassword)

  • Local file (.buildless.toml, .github/buildless.toml, .buildless/config.toml, package.json:buildcache)

  • User-level configuration file (~/.config/buildless.toml, ~/.buildless/config.toml)