174 lines
8.0 KiB
HTML
174 lines
8.0 KiB
HTML
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Swabra - </title>
|
||
|
|
<link rel="stylesheet" href="../../style.css">
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_2.buildFeatures</a> / <a href="./index.html">Swabra</a><br/>
|
||
|
|
<br/>
|
||
|
|
<h1>Swabra</h1>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Swabra</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-feature/index.html"><span class="identifier">BuildFeature</span></a></code>
|
||
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Build+Files+Cleaner+(Swabra)">build feature</a> cleaning files and processes created during a build</p>
|
||
|
|
<p><strong>See Also</strong><br/>
|
||
|
|
<p><a href="#">swabra</a></p>
|
||
|
|
</p>
|
||
|
|
<h3>Types</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="-files-cleanup/index.html">FilesCleanup</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">FilesCleanup</span></code>
|
||
|
|
<p>Files clean-up mode</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="-locking-process-policy/index.html">LockingProcessPolicy</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">LockingProcessPolicy</span></code>
|
||
|
|
<p>Specifies how to handle processes locking some files</p>
|
||
|
|
</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">Swabra</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_2.buildFeatures.Swabra$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_2.buildFeatures.Swabra, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Swabra</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></code><code><span class="identifier">Swabra</span><span class="symbol">(</span><span class="symbol">)</span></code>
|
||
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Build+Files+Cleaner+(Swabra)">build feature</a> cleaning files and processes created during a build</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Properties</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="files-cleanup.html">filesCleanup</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">filesCleanup</span><span class="symbol">: </span><a href="-files-cleanup/index.html"><span class="identifier">FilesCleanup</span></a><span class="symbol">?</span></code>
|
||
|
|
<p>A files clean-up mode to use</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="force-clean-checkout.html">forceCleanCheckout</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">forceCleanCheckout</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>Force <a href="https://www.jetbrains.com/help/teamcity/?Clean+Checkout">clean checkout</a> if cannot restore clean directory state</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="locking-processes.html">lockingProcesses</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">lockingProcesses</span><span class="symbol">: </span><a href="-locking-process-policy/index.html"><span class="identifier">LockingProcessPolicy</span></a><span class="symbol">?</span></code>
|
||
|
|
<p>Whether to inspect the checkout directory for processes locking files in this directory, and what to do with such processes</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="paths.html">paths</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">paths</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>Paths to monitor</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="verbose.html">verbose</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">verbose</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 detailed logging to build log</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Inherited Properties</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-feature/enabled.html">enabled</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">enabled</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>
|
||
|
|
<p>Specifies whether the feature is enabled, true by default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-feature/id.html">id</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">var </span><span class="identifier">id</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>Build feature id, if not specified will be generated</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-build-feature/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>Build feature type</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_2.buildFeatures.Swabra$validate(jetbrains.buildServer.configs.kotlin.v2018_2.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_2/-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_2/-build-feature/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_2/-build-feature/index.html"><span class="identifier">BuildFeature</span></a></code>
|
||
|
|
<p>Creates an instance of this build feature 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_2/-build-feature/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>
|