207 lines
16 KiB
HTML
207 lines
16 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>VcsRoot - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10</a> / <a href="./index.html">VcsRoot</a><br/>
|
|
<br/>
|
|
<h1>VcsRoot</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">VcsRoot</span> <span class="symbol">:</span> <a href="../-parametrized/index.html"><span class="identifier">Parametrized</span></a></code>
|
|
<p>A base class representing TeamCity <a href="https://www.jetbrains.com/help/teamcity/?VCS+root">VCS root</a>.</p>
|
|
<p>To appear in UI a VCS root should be registered in a project using the <a href="../-project/vcs-root.html">vcsRoot</a> method.</p>
|
|
<p>VCS root can be attached to a build configuration or template with specified checkout rules using
|
|
the <a href="../-vcs-settings/root.html">root()</a> method in the <a href="../-build-type-settings/vcs.html">vcs()</a> block.</p>
|
|
<p>The <a href="uuid.html">uuid</a>, <a href="ext-id.html">extId</a>, <a href="name.html">name</a>, and <a href="type.html">type</a> are mandatory properties for a valid VCS root.</p>
|
|
<p>VCS root parameters can be defined via the <a href="../-parametrized/param.html">param</a> method. TeamCity vcs plugins
|
|
extend this class and provide a typed DSL which makes editing parameters easier.</p>
|
|
<p><strong>See Also</strong><br/>
|
|
<p><a href="../-project/index.html">Project</a></p>
|
|
<p><a href="../-build-type/index.html">BuildType</a></p>
|
|
<p><a href="../-template/index.html">Template</a></p>
|
|
</p>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">VcsRoot</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.VcsRoot$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.VcsRoot, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.VcsRoot)/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> {}<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.VcsRoot$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.VcsRoot, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.VcsRoot)/base">base</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code>
|
|
<p>Creates a new VCS root. Copies all settings from the specified
|
|
base (if it is not null) and runs the init function on the created
|
|
instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="ext-id.html">extId</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">extId</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
|
|
<p>VCS root external id. It appears in web UI and is used in urls. Can be
|
|
changed at any time. But be aware that some settings use it, e.g. as a
|
|
part of parameter reference. If you change the extId, you should find
|
|
all its occurrences in the current project and change them too.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="name.html">name</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">name</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
|
|
<p>VCS root name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="poll-interval.html">pollInterval</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">pollInterval</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span></code>
|
|
<p>VCS root polling interval</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="type.html">type</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
|
|
<p>VCS type</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="uuid.html">uuid</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">uuid</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
|
|
<p>VCS root uuid. It is mandatory, TeamCity uses it to identify entities.
|
|
If root's uuid changes, TeamCity considers it to be a new VCS root.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/params.html">params</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">params</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../-parameter/index.html"><span class="identifier">Parameter</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/boolean-parameter.html">booleanParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">booleanParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/trueValue">trueValue</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> "true"<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/falseValue">falseValue</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> "false"<span class="symbol">)</span><span class="symbol">: </span><a href="../-boolean-delegate/index.html"><span class="identifier">BooleanDelegate</span></a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/compound-parameter.html">compoundParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../-compound-param/index.html"><span class="identifier">CompoundParam</span></a><span class="symbol">></span> <span class="identifier">compoundParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$compoundParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-compound-param-delegate/index.html"><span class="identifier">CompoundParamDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/compound-parameter.html#T"><span class="identifier">T</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/enum-parameter.html">enumParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">E</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html"><span class="identifier">Enum</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span><span class="symbol">></span> <span class="identifier">enumParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/mapping">mapping</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">,</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-enum-delegate/index.html"><span class="identifier">EnumDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/int-parameter.html">intParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">intParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$intParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-int-delegate/index.html"><span class="identifier">IntDelegate</span></a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/param.html">param</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">param</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$param(kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$param(kotlin.String, kotlin.String)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
|
|
<p>Adds parameter</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/string-parameter.html">stringParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">stringParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$stringParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-string-delegate/index.html"><span class="identifier">StringDelegate</span></a></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inheritors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.vcs/-git-vcs-root/index.html">GitVcsRoot</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">GitVcsRoot</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>Git <a href="https://www.jetbrains.com/help/teamcity/?Git">VCS root</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.vcs/-hg-vcs-root/index.html">HgVcsRoot</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">HgVcsRoot</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>Mercurial <a href="https://confluence.jetbrains.com/display/TCDL/Mercurial">VCS root</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.vcs/-perforce-vcs-root/index.html">PerforceVcsRoot</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">PerforceVcsRoot</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>Perforce <a href="https://www.jetbrains.com/help/teamcity/?Perforce">VCS root</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.vcs/-svn-vcs-root/index.html">SvnVcsRoot</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SvnVcsRoot</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>A Subversion <a href="https://www.jetbrains.com/help/teamcity/?Subversion">VCS root</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.vcs/-tfs-vcs-root/index.html">TfsVcsRoot</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">TfsVcsRoot</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>TFS <a href="https://www.jetbrains.com/help/teamcity/?Team+Foundation+Server">VCS root</a></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</BODY>
|
|
</HTML>
|