87 lines
4.6 KiB
HTML
87 lines
4.6 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>FreeDiskSpace - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.buildFeatures</a> / <a href="./index.html">FreeDiskSpace</a><br/>
|
|
<br/>
|
|
<h1>FreeDiskSpace</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FreeDiskSpace</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>Build feature ensuring certain <a href="https://www.jetbrains.com/help/teamcity/?Free+disk+space">free disk space</a>
|
|
on the agent before the build by deleting files managed by the TeamCity agent.</p>
|
|
<p><strong>See Also</strong><br/>
|
|
<p><a href="../free-disk-space.html">freeDiskSpace</a></p>
|
|
</p>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">FreeDiskSpace</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.FreeDiskSpace$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.FreeDiskSpace, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.FreeDiskSpace)/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">FreeDiskSpace</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.buildFeatures.FreeDiskSpace$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.FreeDiskSpace, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.FreeDiskSpace)/base">base</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">FreeDiskSpace</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="fail-build.html">failBuild</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">failBuild</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 fail a build if sufficient disk space cannot be freed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="required-space.html">requiredSpace</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">requiredSpace</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>Amount of the free disk space to ensure. Without a suffix treated as bytes.
|
|
Supported suffixes are: kb, mb, gb, tb.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-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</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-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.v10/-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>
|
|
</BODY>
|
|
</HTML>
|