TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/SharedResources

SharedResources

open class SharedResources : BuildFeature

fun BuildFeatures.sharedResources(init: SharedResources.() -> Unit = {})

Adds a Shared Resource build feature which allows limiting concurrently running builds using a shared resource. Note that corrensponding Shared Resources project feature should be defined.

Example. Defines an infinite Shared Resource with an unlimited number of read locks. This Shared Resources then used in build configuration

project {
    // ...
    features {
        // ...
        sharedResource {
            id = "SharedResource_1"
            name = "InfiniteResource"
            resourceType = infinite()
        }
    }

    buildType {
        // ...
        features {
            // ...
            sharedResources {
                // ...
                readLock("InfiniteResource")
            }
        }
    }
}

Example. Adds a Shared Resources build feature which enables different types of locks.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        sharedResources {
            lockSpecificValue("Custom", "value1")
            readLock("InfiniteResource")
            writeLock("Quoted")
        }
Content copied to clipboard
    }
}

Constructors

SharedResources

constructor(init: SharedResources.() -> Unit = {})

Properties

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

type

var type: String

Build feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter