TeamCity Kotlin DSL 2025.11/jetbrains.buildServer.configs.kotlin.vcs/GitVcsRoot/AuthMethod/CustomPrivateKey

CustomPrivateKey

class CustomPrivateKey : GitVcsRoot.AuthMethod

SSH key on the specified path. Supported only for server-side checkout. Switch to uploaded SSH key if you want to use an agent-side checkout.

See also

GitVcsRoot.uploadedKey

Constructors

CustomPrivateKey

constructor()

Properties

var customKeyPath: String?

Path to the SSH key on TeamCity server machine

val params: List<Parameter>

var passphrase: String?

Passphrase for the key. Leave it empty if the key is not encrypted.

var userName: String?

Username to use, overwrites the username in the url

val value: String?

val yamlParams: List<Parameter>

Functions

booleanParameter

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

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

fun clear()

compoundParameter

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

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<T>

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

Copies parameters of this object to the specified target

doubleParameter

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

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

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

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

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

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

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

fun param(name: String, value: String)

Adds parameter with specified name and value

fun removeRawParam(paramName: String)

stringParameter

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

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

open override fun validate(consumer: ErrorConsumer)