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

RemoteParameter

open class RemoteParameter : Parametrized, Validatable

Represents TeamCity Remote Parameter. Use concrete remote parameter classes instead of this class.

Its extensions must be used as a normal parameter would within BuildTypeSettings.params or Project.params

Example. Example vault plugin that specifies a connection to that vault and a query to make

vaultParameter {
    name = "parameterName"
    connection = "vault-connection"
    path = "path/to/data"
    key = "key"
}

Inheritors

HashiCorpVaultParameter

Constructors

RemoteParameter

constructor()

Properties

description

var description: String

display

var display: ParameterDisplay

label

var label: String

name

var name: String

params

val params: List<Parameter>

readOnly

var readOnly: Boolean

type

var type: String

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

copyParamsTo

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

Copies parameters of this object to the specified target

doubleParameter

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open override fun stringParameter(customName: String?): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer