163 lines
11 KiB
HTML
163 lines
11 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>FailureConditions - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2019_2</a> / <a href="./index.html">FailureConditions</a><br/>
|
|
<br/>
|
|
<h1>FailureConditions</h1>
|
|
<code><span class="keyword">class </span><span class="identifier">FailureConditions</span> <span class="symbol">:</span> <a href="../-validatable/index.html"><span class="identifier">Validatable</span></a></code>
|
|
<p>Collection of <a href="../-failure-condition/index.html">failure conditions</a> in <a href="../-build-type/index.html">build configuration</a>
|
|
or <a href="../-template/index.html">template</a></p>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">FailureConditions</span><span class="symbol">(</span><span class="symbol">)</span></code>
|
|
<p>Collection of <a href="../-failure-condition/index.html">failure conditions</a> in <a href="../-build-type/index.html">build configuration</a>
|
|
or <a href="../-template/index.html">template</a></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="error-message.html">errorMessage</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">errorMessage</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>If true, build will fail if any error message is received from logger.
|
|
By default false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="execution-timeout-min.html">executionTimeoutMin</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">executionTimeoutMin</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code>
|
|
<p>Allows to set max build execution time in minutes. If this threshold is exceeded, build fails.
|
|
Default value is 0 - means there is no limit in build execution time</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="java-crash.html">javaCrash</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">javaCrash</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>If true then build will be marked as failed if out of memory error or process crash is detected.
|
|
By default true.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="non-zero-exit-code.html">nonZeroExitCode</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">nonZeroExitCode</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>If true, build will fail if build process exit code was non-zero.
|
|
By default true.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="test-failure.html">testFailure</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">testFailure</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>If true, build will fail if there is at least one failed test.
|
|
By default true.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="failure-condition.html">failureCondition</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">failureCondition</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions$failureCondition(jetbrains.buildServer.configs.kotlin.v2019_2.FailureCondition)/failureCondition">failureCondition</span><span class="symbol">:</span> <a href="../-failure-condition/index.html"><span class="identifier">FailureCondition</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>Adds the specified failure condition</p>
|
|
<code><span class="keyword">fun </span><span class="identifier">failureCondition</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions$failureCondition(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2019_2.FailureCondition, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../-failure-condition/index.html"><span class="identifier">FailureCondition</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><a href="../-failure-condition/index.html"><span class="identifier">FailureCondition</span></a></code>
|
|
<p>Adds a failure condition initialized with the specified init block</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="option.html">option</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">option</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions$option(kotlin.String, kotlin.String)/name">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><span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions$option(kotlin.String, kotlin.String)/value">value</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><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 option with specified name and value</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="validate.html">validate</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">validate</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions$validate(jetbrains.buildServer.configs.kotlin.v2019_2.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span> <a href="../-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>Extension Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../copy.html">copy</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">FailureConditions</span></a><span class="symbol">.</span><span class="identifier">copy</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">FailureConditions</span></a></code>
|
|
<p>Copies the receiver failure conditions</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../copy-to.html">copyTo</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">FailureConditions</span></a><span class="symbol">.</span><span class="identifier">copyTo</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2$copyTo(jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions, jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions)/target">target</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">FailureConditions</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">FailureConditions</span></a></code>
|
|
<p>Copies the receiver failure conditions to the specified target</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/fail-on-metric-change.html">failOnMetricChange</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">FailureConditions</span></a><span class="symbol">.</span><span class="identifier">failOnMetricChange</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.failureConditions$failOnMetricChange(jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2019_2.failureConditions.BuildFailureOnMetric, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/-build-failure-on-metric/index.html"><span class="identifier">BuildFailureOnMetric</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><a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/-build-failure-on-metric/index.html"><span class="identifier">BuildFailureOnMetric</span></a></code>
|
|
<p>Adds a <a href="https://www.jetbrains.com/help/teamcity/?Build+Failure+Conditions#BuildFailureConditions-Failbuildonmetricchange">build failure condition</a>
|
|
failing build on metric change.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/fail-on-text.html">failOnText</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><a href="./index.html"><span class="identifier">FailureConditions</span></a><span class="symbol">.</span><span class="identifier">failOnText</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.failureConditions$failOnText(jetbrains.buildServer.configs.kotlin.v2019_2.FailureConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2019_2.failureConditions.BuildFailureOnText, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/-build-failure-on-text/index.html"><span class="identifier">BuildFailureOnText</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><a href="../../jetbrains.build-server.configs.kotlin.v2019_2.failure-conditions/-build-failure-on-text/index.html"><span class="identifier">BuildFailureOnText</span></a></code>
|
|
<p>Adds a <a href="https://www.jetbrains.com/help/teamcity/?Build+Failure+Conditions#BuildFailureConditions-Failbuildonspecifictextinbuildlog">build failure condition</a> failing build
|
|
when specified text is found in a build log.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</BODY>
|
|
</HTML>
|