gradle/org.gradle.api.artifacts/ConfigurationContainer/consumable

consumable

@Incubating
abstract fun consumable(name: String): NamedDomainObjectProvider<ConsumableConfiguration>(source)

Registers a new ConsumableConfiguration with an immutable role. Consumable configurations are meant to act as a variant in the context of Dependency Management and Publishing.

This operation is lazy, the returned element is NOT realized. A lazy wrapper is returned, allowing to continue to use it with other lazy APIs.

Return

A provider which creates a new consumable configuration.

Since

8.4

Parameters

name

The name of the configuration to register.

Throws

If a configuration with the given name already exists in this container.

@Incubating
abstract fun consumable(    name: String,     action: Action<in ConsumableConfiguration>): NamedDomainObjectProvider<ConsumableConfiguration>(source)

Registers a ConsumableConfiguration via consumable and then configures it with the provided action.

This operation is lazy, the returned element is NOT realized. A lazy wrapper is returned, allowing to continue to use it with other lazy APIs.

Return

A provider which creates a new consumable configuration.

Since

8.4

Parameters

name

The name of the configuration to register.

action

The action to apply to the configuration.

Throws

If a configuration with the given name already exists in this container.