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:******"
        }
    }
}

See also

Constructors

Link copied to clipboard
constructor(init: PerforceAdminConnection.() -> Unit)
constructor()

Properties

Link copied to clipboard
var id: String?

Project feature id, if not specified will be generated

Link copied to clipboard
var name: String?

Perforce administrator connection display name

Link copied to clipboard
Link copied to clipboard

A password for Perforce connection

Link copied to clipboard
var port: String?

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

Link copied to clipboard

Project feature type

Link copied to clipboard

A username for Perforce connection

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): DelegateProvider<Boolean?>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(    customName: String? = null): DelegateProvider<T>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard

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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): DelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(    customName: String? = null,     mapping: Map<E, String?>? = null): DelegateProvider<E>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): DelegateProvider<Int>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): DelegateProvider<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer