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

310 lines
16 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>SvnVcsRoot - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_1.vcs</a>&nbsp;/&nbsp;<a href="./index.html">SvnVcsRoot</a><br/>
<br/>
<h1>SvnVcsRoot</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SvnVcsRoot</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-externals-mode/index.html">ExternalsMode</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">ExternalsMode</span></code>
<p>Subversion externals mode</p>
</td>
</tr>
<tr>
<td>
<p><a href="-working-copy-format/index.html">WorkingCopyFormat</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">WorkingCopyFormat</span></code>
<p>A Subversion working copy format</p>
</td>
</tr>
</tbody>
</table>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">SvnVcsRoot</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.vcs.SvnVcsRoot$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_1.vcs.SvnVcsRoot, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">SvnVcsRoot</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span></code><code><span class="identifier">SvnVcsRoot</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>A Subversion <a href="https://www.jetbrains.com/help/teamcity/?Subversion">VCS root</a></p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="config-dir.html">configDir</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">configDir</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></code>
<p>Custom Subversion configuration directory to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="custom-ssh-key.html">customSshKey</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">customSshKey</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></code>
<p>A path to SSH key on the TeamCity server machine to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="enable-non-trusted-s-s-l.html">enableNonTrustedSSL</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">enableNonTrustedSSL</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span></code>
<p>Whether TeamCity should accept non-trusted SSL certificates from Subversion server</p>
</td>
</tr>
<tr>
<td>
<p><a href="externals-mode.html">externalsMode</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">externalsMode</span><span class="symbol">: </span><a href="-externals-mode/index.html"><span class="identifier">ExternalsMode</span></a><span class="symbol">?</span></code>
<p>A mode of externals support</p>
</td>
</tr>
<tr>
<td>
<p><a href="labeling-message.html">labelingMessage</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">labelingMessage</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></code>
<p>A message to use for labeling</p>
</td>
</tr>
<tr>
<td>
<p><a href="labeling-rules.html">labelingRules</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">labelingRules</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></code>
<p><a href="https://www.jetbrains.com/help/teamcity/?VCS+Labeling#VCSLabeling-SubversionLabelingRules">Labeling patterns</a> to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="passphrase.html">passphrase</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">passphrase</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></code>
<p>A passphrase for SSH key if it is encrypted</p>
</td>
</tr>
<tr>
<td>
<p><a href="password.html">password</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">password</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></code>
<p>A password for Subversion connection</p>
</td>
</tr>
<tr>
<td>
<p><a href="ssh-port.html">sshPort</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">sshPort</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>SSH port to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="uploaded-key.html">uploadedKey</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">uploadedKey</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></code>
<p>Name of the uploaded <a href="https://www.jetbrains.com/help/teamcity/?SSH+Keys+Management">SSH key</a> to use for connections via SSH.</p>
</td>
</tr>
<tr>
<td>
<p><a href="url.html">url</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">url</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></code>
<p>Subversion server URL</p>
</td>
</tr>
<tr>
<td>
<p><a href="use-default-config-dir.html">useDefaultConfigDir</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">useDefaultConfigDir</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span></code>
<p>Whether the default Subversion configuration directory should be used</p>
</td>
</tr>
<tr>
<td>
<p><a href="user-name.html">userName</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">userName</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></code>
<p>A username for Subversion connection</p>
</td>
</tr>
<tr>
<td>
<p><a href="working-copy-format.html">workingCopyFormat</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">workingCopyFormat</span><span class="symbol">: </span><a href="-working-copy-format/index.html"><span class="identifier">WorkingCopyFormat</span></a><span class="symbol">?</span></code>
<p>Subversion working copy format to use</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/id.html">id</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-id/index.html"><span class="identifier">Id</span></a><span class="symbol">?</span></code>
<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="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/uuid.html">uuid</a> specified, then the id can be changed at any time.
If <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/param-refs.html">paramRefs</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">paramRefs</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root-refs/index.html"><span class="identifier">VcsRootRefs</span></a></code>
<p>Helper for creating <a href="https://www.jetbrains.com/help/teamcity/?Predefined+Build+Parameters#PredefinedBuildParameters-VCSProperties">references to parameters</a> of this VCS root</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/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. 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.</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="validate.html">validate</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">validate</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.vcs.SvnVcsRoot$validate(jetbrains.buildServer.configs.kotlin.v2018_1.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-error-consumer/index.html"><span class="identifier">ErrorConsumer</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>Validates this object and reports found errors to the provided consumer</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/create.html">create</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">create</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/index.html"><span class="identifier">VcsRoot</span></a></code>
<p>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.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/equals.html">equals</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">equals</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.VcsRoot$equals(kotlin.Any)/other">other</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/id.html">id</a></p>
</td>
<td>
<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="../../jetbrains.build-server.configs.kotlin.v2018_1/-dsl-context/index.html">context</a>
in which DSL is executed: it is <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-relative-id/index.html">RelativeId</a> when DSL context <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-dsl-context/is-relative.html">is relative</a>,
otherwise it is <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-absolute-id/index.html">AbsoluteId</a>.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-vcs-root/to-string.html">toString</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</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></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>