TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/SshAgent

SshAgent

fun BuildFeatures.sshAgent(init: SshAgent.() -> Unit): SshAgent

A build feature which runs SSH agent during a build with the specified SSH key loaded

Example. Adds an SSH Agent build feature with specified uploaded ssh key ID and passphrase (optional parameter).

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        sshAgent {
            teamcitySshKey = "id"
            passphrase = "credentialsJSON:******"
        }
Content copied to clipboard
    }
}

Constructors

SshAgent

fun SshAgent(init: SshAgent.() -> Unit)

SshAgent

fun SshAgent()

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam