TriggerBuildParameters

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

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Functions

Link copied to clipboard
fun add(p: Parameter)

Adds the specified parameter

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
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

Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(    customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(    customName: String? = null,     mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard

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

Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

fun param(name: String, value: String, type: String? = null, vararg arguments: <Error class: unknown class><String, String>)
Link copied to clipboard
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

Link copied to clipboard
fun remote(remoteParameter: RemoteParameter)
fun remote(    name: String,     label: String = "",     description: String = "",     display: ParameterDisplay = ParameterDisplay.NORMAL,     readOnly: Boolean = false,     remoteType: String,     vararg params: <Error class: unknown class><String, String>)

Adds a remote parameter from a specific remote type

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
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

Link copied to clipboard
open fun stringParameter(    customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
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

Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer