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

Constructors

Link copied to clipboard
fun RemoteParameter()

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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
fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
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): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
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 override fun stringParameter(customName: String?): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var description: String
Link copied to clipboard
var display: ParameterDisplay
Link copied to clipboard
var label: String
Link copied to clipboard
var name: String
Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var readOnly: Boolean = false
Link copied to clipboard
var type: String