jetbrains.buildServer.configs.kotlin.v2018_1 / ParametrizedWithType

ParametrizedWithType

open class ParametrizedWithType : Parametrized

Allows to add parameters to project, build configuration, or template

Constructors

<init>

ParametrizedWithType()

Allows to add parameters to project, build configuration, or template

Inherited Properties

params

val params: List<Parameter>

Functions

add

fun add(p: Parameter): Unit

Adds the specified parameter

checkbox

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

Adds a checkbox parameter

param

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

password

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

Adds a password parameter, TeamCity masks its value in UI

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()): Unit

Adds a parameter with predefined set of possible values

text

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

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 = ""): Unit

Adds a text parameter validated by the specified regex

Inherited Functions

booleanParameter

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

compoundParameter

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

copyParamsTo

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

Copies parameters of this object to the specified target

enumParameter

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

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

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

param

fun param(name: String, value: String): Unit

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String): Unit

stringParameter

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