256 lines
14 KiB
HTML
256 lines
14 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>PerforceVcsRoot - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.vcs</a> / <a href="./index.html">PerforceVcsRoot</a><br/>
|
|
<br/>
|
|
<h1>PerforceVcsRoot</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">PerforceVcsRoot</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v10/-vcs-root/index.html"><span class="identifier">VcsRoot</span></a></code>
|
|
<p>Perforce <a href="https://www.jetbrains.com/help/teamcity/?Perforce">VCS root</a></p>
|
|
<h3>Types</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-mode/index.html">Mode</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">Mode</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v10/-compound-param/index.html"><span class="identifier">CompoundParam</span></a></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">PerforceVcsRoot</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot)/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">PerforceVcsRoot</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.vcs.PerforceVcsRoot$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot)/base">base</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">PerforceVcsRoot</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="charset-name.html">charsetName</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">charsetName</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 charset to use on the client machine</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="checkout-revision.html">checkoutRevision</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">checkoutRevision</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/?Perforce#Perforce-perforceLabelToCheckout">Custom</a> Perforce revision to checkout</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="mode.html">mode</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">mode</span><span class="symbol">: </span><a href="-mode/index.html"><span class="identifier">Mode</span></a><span class="symbol">?</span></code>
|
|
<p>A mode of Perforce connection</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="non-stream-workspace.html">nonStreamWorkspace</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">nonStreamWorkspace</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>When set, the created Perforce workspace on agent will not be stream-enabled.
|
|
The option allows using arbitrary checkout rules, but prohibits commits from agent into the stream.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="p4-path.html">p4Path</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">p4Path</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 p4 executable</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 Perforce connection</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="port.html">port</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">port</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 Perforce server address in the "host:port" format</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="run-p4-clean.html">runP4Clean</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">runP4Clean</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 run 'p4 clean' command before the build</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="skip-have-list-update.html">skipHaveListUpdate</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">skipHaveListUpdate</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>Whether TeamCity should track files on the Perforce server on sync</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="support-utf16.html">supportUtf16</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">supportUtf16</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>Enables support for files with UTF-16 encoding</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="sync-options.html">syncOptions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">syncOptions</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>Additional options for the <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_sync.html">p4 sync</a> command</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="use-ticket-based-auth.html">useTicketBasedAuth</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><s><span class="identifier">useTicketBasedAuth</span></s><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></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 Perforce connection</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="workspace-options.html">workspaceOptions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">workspaceOptions</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/?Perforce#Perforce-perforceWorkspaceOptions">Settings</a>
|
|
for the <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_client.html#p4_client.form_fields">p4 client</a> command.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-vcs-root/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="../../jetbrains.build-server.configs.kotlin.v10/-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.v10/-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.v10/-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.v10/-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. 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>Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="client.html">client</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">client</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot$client(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot.Mode.Client, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-mode/-client/index.html"><span class="identifier">Client</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="symbol">: </span><a href="-mode/-client/index.html"><span class="identifier">Client</span></a></code>
|
|
<p>Connect to to Perforce using the specified <a href="https://www.jetbrains.com/help/teamcity/?Perforce#Perforce-perforceClientOptionDescription">client name</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="client-mapping.html">clientMapping</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">clientMapping</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot$clientMapping(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot.Mode.ClientMapping, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-mode/-client-mapping/index.html"><span class="identifier">ClientMapping</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="symbol">: </span><a href="-mode/-client-mapping/index.html"><span class="identifier">ClientMapping</span></a></code>
|
|
<p>Connect to Perforce using the specified <a href="https://www.jetbrains.com/help/teamcity/?Perforce#Perforce-perforceClientMappingOptionDescription">client mapping</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="stream.html">stream</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">stream</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot$stream(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.vcs.PerforceVcsRoot.Mode.Stream, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-mode/-stream/index.html"><span class="identifier">Stream</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="symbol">: </span><a href="-mode/-stream/index.html"><span class="identifier">Stream</span></a></code>
|
|
<p>Connect to <a href="https://www.jetbrains.com/help/teamcity/?Perforce#Perforce-perforceStreamOptionDescription">Perforce stream</a> with specified name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</BODY>
|
|
</HTML>
|