open class VcsRoot : Parametrized, Validatable, IdOwner
A base class representing TeamCity VCS root.
To appear in UI a VCS root should be registered in a project using the vcsRoot method.
VCS root can be attached to a build configuration or template with specified checkout rules using the root() method in the vcs() block.
The id, name, and type are mandatory properties for a valid VCS root (id can be omitted if it matches the class name).
VCS root parameters can be defined via the param method. TeamCity vcs plugins extend this class and provide a typed DSL which makes editing parameters easier.
See Also
VcsRoot(init: VcsRoot.() -> Unit)
Creates a VCS root and initializes it with the specified init block VcsRoot()
A base class representing TeamCity VCS root. |
open var id: Id?
VCS root id.
It appears in the web UI and is used in urls.
If the VCS root has a uuid specified, then the id can be changed at any time.
If uuid is omitted, then TeamCity treats a VCS root with a changed id as
a new VCS root, all data associated with the old root will be lost (e.g.
a commits graph). Id can also be used by some settings, e.g. as a
part of parameter reference. If you change the id, you should find
all its occurrences in the current project and change them too.
Id must be unique across all VCS roots on the server.
If id is missing, it will be generated from the class name (if the class is not from
the |
|
var name: String
VCS root name |
|
open val paramRefs: VcsRootRefs
Helper for creating references to parameters of this VCS root |
|
var pollInterval: Int?
VCS root polling interval |
|
var type: String
VCS type |
|
var uuid: String
VCS root uuid. TeamCity uses it to identify the VCS root. If uuid changes, TeamCity considers it to be a new entity. If uuid is missing, it is reconstructed from VCS root id. Uuid must be unique across all entities on the server. |
val params: List<Parameter> |
open fun create(): VcsRoot
Creates an instance of this VCS root 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. |
|
open fun equals(other: Any?): Boolean |
|
fun id(id: String): Unit
Sets the id to the specified value. Type of the id depends on the context in which DSL is executed: it is RelativeId when DSL context is relative, otherwise it is AbsoluteId. |
|
open fun toString(): String |
|
open fun validate(consumer: ErrorConsumer): Unit
Validates this object and reports found errors to the provided consumer |
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean> |
|
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T> |
|
fun <T : Parametrized> copyParamsTo(target: T): T
Copies parameters of this object to the specified target |
|
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E> |
|
fun findRawParam(paramName: String): Parameter? |
|
fun hasParam(paramName: String): Boolean |
|
fun intParameter(customName: String? = null): SingleDelegateProvider<Int> |
|
fun param(name: String, value: String): Unit
Adds parameter with specified name and value |
|
fun removeRawParam(paramName: String): Unit |
|
fun stringParameter(customName: String? = null): SingleDelegateProvider<String> |
fun <T : VcsRoot> T.copy(): T
Copies the receiver VCS root. fun <T : VcsRoot> T.copy(block: T.() -> Unit): T
Copies the receiver VCS root and initialize it with the specified block. |
|
fun <T : VcsRoot> T.copyTo(target: T): T
Copies the receiver VCS root to the specified target VCS root |
open class GitVcsRoot : VcsRoot
Git VCS root |
|
open class HgVcsRoot : VcsRoot
Mercurial VCS root |
|
open class PerforceVcsRoot : VcsRoot
Perforce VCS root |
|
open class SvnVcsRoot : VcsRoot
A Subversion VCS root |
|
open class TfsVcsRoot : VcsRoot
TFS VCS root |