jetbrains.buildServer.configs.kotlin.v2018_2.vcs / HgVcsRoot

HgVcsRoot

open class HgVcsRoot : VcsRoot

Mercurial VCS root

Types

PurgePolicy

enum class PurgePolicy

Defines hg purge settings

Constructors

<init>

HgVcsRoot(init: HgVcsRoot.() -> Unit)HgVcsRoot()

Mercurial VCS root

Properties

branch

var branch: String?

Default branch name

branchSpec

var branchSpec: String?

Branch specification to use in VCS root

customHgConfig

var customHgConfig: String?

Mercurial configuration options to be applied to the repository in the standard format

detectSubrepoChanges

var detectSubrepoChanges: Boolean?

Whether TeamCity should detect changes in submodules

hgPath

var hgPath: String?

Path to hg executable

password

var password: String?

A password for mercurial connection

purgePolicy

var purgePolicy: PurgePolicy?

Specifies whether TeamCity should run the hg purge command and what files should be purged

url

var url: String?

Mercurial repository URL

useMirrors

var useMirrors: Boolean?

When set to true, TeamCity creates a local agent mirror first (under agent's system/mercurial directory) and then clones to the build checkout directory from this local mirror. This option speeds up clean checkout, because only the build working directory is cleaned. Also, if a single root is used in several build configurations, a clone will be faster.

useTagsAsBranches

var useTagsAsBranches: Boolean?

Allows to use tags in branch specification. By default, tags are ignored.

userForTags

var userForTags: String?

A custom username for tags. Format: User Name

userName

var userName: String?

A username for mercurial connection

Inherited Properties

id

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 jetbrains.buildServer.configs.kotlin.v2018_2 package).

name

var name: String

VCS root name

paramRefs

open val paramRefs: VcsRootRefs

Helper for creating references to parameters of this VCS root

pollInterval

var pollInterval: Int?

VCS root polling interval

type

var type: String

VCS type

uuid

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.

Functions

validate

open fun validate(consumer: ErrorConsumer): Unit

Validates this object and reports found errors to the provided consumer

Inherited Functions

create

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.

equals

open fun equals(other: Any?): Boolean

id

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.

toString

open fun toString(): String