TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/PerforceAdminConnection

PerforceAdminConnection

open class PerforceAdminConnection : ProjectFeature

fun ProjectFeatures.perforceAdminAccess(init: PerforceAdminConnection.() -> Unit): PerforceAdminConnection

This connection is used for some Perforce adminstration tasks on the TeamCity server. See cleaning workspaces on Perforce Server.

Example. Configure a Perforce admin connection to perforce:1666 with the given username and password (or ticket).

project {
    ...
    features {
        perforceAdminAccess {
            id = "PerforceAdminAccessConnection"
            name = "Perforce Administrator Access"
            port = "perforce:1666"
            userName = "admin"
            password = "credentialsJSON:******"
        }
    }
}

Constructors

PerforceAdminConnection

constructor(init: PerforceAdminConnection.() -> Unit)

constructor()

Properties

var id: String?

Project feature id, if not specified will be generated

name

var name: <Error class: unknown class>

Perforce administrator connection display name

params

val params: List<Parameter>

password

var password: <Error class: unknown class>

A password for Perforce connection

port

var port: <Error class: unknown class>

A Perforce server address in the "host:port" format

type

var type: String

Project feature type

userName

var userName: <Error class: unknown class>

A username for Perforce connection

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

create

open fun create(): ProjectFeature

Creates an instance of this project 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: 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