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

TriggerBuildParameters

class TriggerBuildParameters : ParametrizedWithType

Set of build parameters that are added to builds triggered by a trigger.

Example. Append two additional parameters to triggered build.

buildType {
    // ...
    triggers {
        retryBuild {
            // ...
            buildParams {
                param("param1", "value1")
                param("param2", "%build.number%")
            }
        }
    }
}

Since

2021.1

Constructors

TriggerBuildParameters

constructor()

Properties

params

val params: List<Parameter>

Functions

add

fun add(p: Parameter)

Adds the specified parameter

booleanParameter

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

checkbox

fun checkbox(name: String, value: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false, checked: String? = null, unchecked: String? = null)

Adds a checkbox parameter

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

doubleParameter

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hashiCorpVaultParameter

fun ParametrizedWithType.hashiCorpVaultParameter(init: HashiCorpVaultParameter.() -> Unit): HashiCorpVaultParameter

Example. Adds a new vault parameter with the name test that will fetch a value from the KV 1.0 vault named secret from the path path/to, with the key key. The connection namespace to use it is connection-1

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): DelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

fun param(name: String, value: String, type: String? = null, vararg arguments: Pair<String, String>)

password

fun password(name: String, value: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false)

Adds a password parameter, TeamCity masks its value in UI

remote

fun remote(remoteParameter: RemoteParameter)

fun remote(name: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false, remoteType: String, vararg params: Pair<String, String>)

Adds a remote parameter from a specific remote type

removeRawParam

fun removeRawParam(paramName: String)

select

fun select(name: String, value: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false, allowMultiple: Boolean = false, valueSeparator: String = ",", options: List<Any> = listOf())

Adds a parameter with predefined set of possible values

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

text

fun text(name: String, value: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false, allowEmpty: Boolean)

Adds a text parameter

fun text(name: String, value: String, label: String = "", description: String = "", display: ParameterDisplay = ParameterDisplay.NORMAL, readOnly: Boolean = false, regex: String = "", validationMessage: String = "")

Adds a text parameter validated by the specified regex

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer