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

Requirements

Collection of agent requirements in build configuration or template.

Example. Requirements for different agent OSes

buildType {
    // ...
    requirements {
      contains("teamcity.agent.jvm.os.name", "Windows")
    }
}

requirements {
    contains("teamcity.agent.jvm.os.name", "Linux")
}

requirements {
    contains("teamcity.agent.jvm.os.name", "Mac OS X")
}

Example. Requirement for an agent with a running Docker server on Linux OS

requirements {
    exists("docker.server.version")
    contains("teamcity.agent.jvm.os.name", "Linux")
}

Example. Requirement for an agent with a specific parameter in its buildAgent.properties file

requirements {
    exists("my.custom.parameter")
}

Constructors

Requirements

fun Requirements()

Functions

contains

fun contains( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter contains the given value

doesNotContain

fun doesNotContain( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter does not contain the given value

doesNotEqual

fun doesNotEqual( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is not equal to the given value

doesNotExist

fun doesNotExist(param: String, id: String? = null)

Adds a requirement that the parameter with the specified name does not exist on the agent

doesNotMatch

fun doesNotMatch( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter does not match the given value

endsWith

fun endsWith( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter ends with the given value

equals

fun equals( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is equal to the given value

exists

fun exists(param: String, id: String? = null)

Adds a requirement that the parameter with the specified name exists on the agent

lessThan

fun lessThan( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is less than the given value

lessThanVer

fun lessThanVer( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is less than the given value as a version

matches

fun matches( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter matches the given value

moreThan

fun moreThan( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is greater than the given value

moreThanVer

fun moreThanVer( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is greater than the given value as a version

noLessThan

fun noLessThan( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is not less than the given value

noLessThanVer

fun noLessThanVer( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is not less than the given value as a version

noMoreThan

fun noMoreThan( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is not greater than the given value

noMoreThanVer

fun noMoreThanVer( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter is not greater than the given value as a version

requirement

fun requirement(r: Requirement)

Adds the specified requirement

startsWith

fun startsWith( param: String, value: String, id: String? = null)

Adds a requirement that the value of the specified parameter starts with the given value

Inheritors

BuildStepConditions

Extensions

copy

fun Requirements.copy(): Requirements

Copies the receiver requirements

copyTo

fun Requirements.copyTo(target: Requirements): Requirements

Copies the receiver requirements to the specified target