184 lines
15 KiB
HTML
184 lines
15 KiB
HTML
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Trigger - </title>
|
||
|
|
<link rel="stylesheet" href="../../style.css">
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10</a> / <a href="./index.html">Trigger</a><br/>
|
||
|
|
<br/>
|
||
|
|
<h1>Trigger</h1>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Trigger</span> <span class="symbol">:</span> <a href="../-parametrized/index.html"><span class="identifier">Parametrized</span></a></code>
|
||
|
|
<p>TeamCity <a href="https://www.jetbrains.com/help/teamcity/?Configuring+Build+Triggers">build trigger</a></p>
|
||
|
|
<h3>Constructors</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="-init-.html"><init></a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="identifier">Trigger</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Trigger$<init>(jetbrains.buildServer.configs.kotlin.v10.Trigger, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.Trigger, kotlin.Unit)))/base">base</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Trigger$<init>(jetbrains.buildServer.configs.kotlin.v10.Trigger, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.Trigger, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</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></code></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Properties</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="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 trigger is enabled</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="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>Trigger id, if not set will be generated</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="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>Trigger type</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Inherited Properties</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/params.html">params</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">params</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../-parameter/index.html"><span class="identifier">Parameter</span></a><span class="symbol">></span></code></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Inherited Functions</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/boolean-parameter.html">booleanParameter</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="identifier">booleanParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/customName">customName</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> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/trueValue">trueValue</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> "true"<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/falseValue">falseValue</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> "false"<span class="symbol">)</span><span class="symbol">: </span><a href="../-boolean-delegate/index.html"><span class="identifier">BooleanDelegate</span></a></code></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/compound-parameter.html">compoundParameter</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../-compound-param/index.html"><span class="identifier">CompoundParam</span></a><span class="symbol">></span> <span class="identifier">compoundParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$compoundParameter(kotlin.String)/customName">customName</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> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-compound-param-delegate/index.html"><span class="identifier">CompoundParamDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/compound-parameter.html#T"><span class="identifier">T</span></a><span class="symbol">></span></code></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/enum-parameter.html">enumParameter</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">E</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html"><span class="identifier">Enum</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span><span class="symbol">></span> <span class="identifier">enumParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/customName">customName</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> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/mapping">mapping</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><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><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-enum-delegate/index.html"><span class="identifier">EnumDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span></code></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/int-parameter.html">intParameter</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="identifier">intParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$intParameter(kotlin.String)/customName">customName</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> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-int-delegate/index.html"><span class="identifier">IntDelegate</span></a></code></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/param.html">param</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="identifier">param</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$param(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.v10.Parametrized$param(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>Adds parameter</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../-parametrized/string-parameter.html">stringParameter</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">fun </span><span class="identifier">stringParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$stringParameter(kotlin.String)/customName">customName</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> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-string-delegate/index.html"><span class="identifier">StringDelegate</span></a></code></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3>Inheritors</h3>
|
||
|
|
<table>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-finish-build-trigger/index.html">FinishBuildTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FinishBuildTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>Base class for <a href="https://www.jetbrains.com/help/teamcity/?Configuring+Finish+Build+Trigger">Finish Build Triggers</a>.
|
||
|
|
Finish build trigger runs build when some other build finishes.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-maven-artifact-dependency-trigger/index.html">MavenArtifactDependencyTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">MavenArtifactDependencyTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Configuring+Maven+Triggers#ConfiguringMavenTriggers-MavenArtifactDependencyTrigger">trigger</a>
|
||
|
|
running builds when there is a modification of the maven dependency content.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-maven-snapshot-dependency-trigger/index.html">MavenSnapshotDependencyTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">MavenSnapshotDependencyTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Configuring+Maven+Triggers#ConfiguringMavenTriggers-MavenSnapshotDependencyTrigger">trigger</a>
|
||
|
|
running builds when there is a modification of the snapshot dependency content in the remote repository.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-retry-build-trigger/index.html">RetryBuildTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">RetryBuildTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>Triggers the build if the previous build failed after a specified time delay</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-schedule-trigger/index.html">ScheduleTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">ScheduleTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>Base class for <a href="https://www.jetbrains.com/help/teamcity/?Configuring+Schedule+Triggers">Schedule Build Triggers</a>.
|
||
|
|
Schedule trigger runs builds by specified schedule.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.triggers/-vcs-trigger/index.html">VcsTrigger</a></p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">VcsTrigger</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Trigger</span></a></code>
|
||
|
|
<p>Base class for <a href="https://www.jetbrains.com/help/teamcity/?Configuring+VCS+Triggers">VCS triggers</a>.
|
||
|
|
VCS trigger automatically starts a new build each time TeamCity detects new changes.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|