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

SharedResource

open class SharedResource : ProjectFeature

fun ProjectFeatures.sharedResource(init: SharedResource.() -> Unit)

Adds a Shared Resource project feature which allows limiting concurrently running builds using a shared resource. Note that a shared should be defined in project settings and then enabled in reguired build configurations.

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 = "InfiniteResource_1"
            name = "InfiniteResource"
            resourceType = infinite()
        }
    }

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

Example. Defines a quoted Shared Resource. Quota is a maximum number of read locks that can be acquired on the resource.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        sharedResource {
            id = "Quoted_1"
            name = "Quoted"
            resourceType = quoted(5)
        }
Content copied to clipboard
    }
}

Example. Defines a Shared Resource with custom values.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        sharedResource {
            id = "CustomSharedResource_1"
            name = "Custom"
            resourceType = customValues(
                "value1",
                "value2"
            )
        }
Content copied to clipboard
    }
}

Constructors

SharedResource

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

Types

SharedResourceType

abstract class SharedResourceType

Properties

enabled

var enabled: Boolean?

If Shared Resource is enabled

var id: String?

Project feature id, if not specified will be generated

name

var name: String?

Shared Resource name

params

val params: List<Parameter>

resourceType

var resourceType: SharedResource.SharedResourceType?

Shared Resource type, e.g. infinite, quoted or customValues

type

var type: String

Project 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(): ProjectFeature

Creates an instance of this project 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.

customValues