crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/id.html
2021-01-18 15:27:50 -05:00

70 lines
4.5 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>VcsRoot.id - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_1</a>&nbsp;/&nbsp;<a href="index.html">VcsRoot</a>&nbsp;/&nbsp;<a href="./id.html">id</a><br/>
<br/>
<h1>id</h1>
<a name="jetbrains.buildServer.configs.kotlin.v2018_1.VcsRoot$id"></a>
<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="../-id/index.html"><span class="identifier">Id</span></a><span class="symbol">?</span></code>
<p>Overrides <a href="../-id-owner/id.html">IdOwner.id</a></p>
<p>VCS root <a href="https://www.jetbrains.com/help/teamcity/?Identifier">id</a>.
It appears in the web UI and is used in urls.
If the VCS root has a <a href="uuid.html">uuid</a> specified, then the id can be changed at any time.
If <a href="uuid.html">uuid</a> 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 <code>jetbrains.buildServer.configs.kotlin.v2018_1</code> package).</p>
<p><strong>See Also</strong><br/>
<p><a href="../-id/index.html">Id</a></p>
<p><a href="../kotlin.-string/to-id.html">toId</a></p>
</p>
<p><strong>Getter</strong><br/>
<p>VCS root <a href="https://www.jetbrains.com/help/teamcity/?Identifier">id</a>.
It appears in the web UI and is used in urls.
If the VCS root has a <a href="uuid.html">uuid</a> specified, then the id can be changed at any time.
If <a href="uuid.html">uuid</a> 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 <code>jetbrains.buildServer.configs.kotlin.v2018_1</code> package).</p>
</p>
<p><strong>Getter See Also</strong><br/>
<p><a href="../-id/index.html">Id</a></p>
<p><a href="../kotlin.-string/to-id.html">toId</a></p>
</p>
<p><strong>Setter</strong><br/>
<p>VCS root <a href="https://www.jetbrains.com/help/teamcity/?Identifier">id</a>.
It appears in the web UI and is used in urls.
If the VCS root has a <a href="uuid.html">uuid</a> specified, then the id can be changed at any time.
If <a href="uuid.html">uuid</a> 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 <code>jetbrains.buildServer.configs.kotlin.v2018_1</code> package).</p>
</p>
<p><strong>Setter See Also</strong><br/>
<p><a href="../-id/index.html">Id</a></p>
<p><a href="../kotlin.-string/to-id.html">toId</a></p>
</p>
<a name="jetbrains.buildServer.configs.kotlin.v2018_1.VcsRoot$id(kotlin.String)"></a>
<code><span class="keyword">fun </span><span class="identifier">id</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.VcsRoot$id(kotlin.String)/id">id</span><span class="symbol">:</span>&nbsp;<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>Sets the id to the specified value. Type of the id depends on the <a href="../-dsl-context/index.html">context</a>
in which DSL is executed: it is <a href="../-relative-id/index.html">RelativeId</a> when DSL context <a href="../-dsl-context/is-relative.html">is relative</a>,
otherwise it is <a href="../-absolute-id/index.html">AbsoluteId</a>.</p>
</BODY>
</HTML>