crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v2018_1/-artifact-dependency/index.html
2021-01-18 15:27:50 -05:00

162 lines
8.7 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ArtifactDependency - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_1</a>&nbsp;/&nbsp;<a href="./index.html">ArtifactDependency</a><br/>
<br/>
<h1>ArtifactDependency</h1>
<code><span class="keyword">class </span><span class="identifier">ArtifactDependency</span></code>
<p>TeamCity <a href="https://www.jetbrains.com/help/teamcity/?Artifact+Dependencies">artifact dependency</a>.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">ArtifactDependency</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>TeamCity <a href="https://www.jetbrains.com/help/teamcity/?Artifact+Dependencies">artifact dependency</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="artifact-rules.html">artifactRules</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">artifactRules</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>New-line separated list of artifact rules specifying the way artifacts from the dependency should be copied.
Mandatory, empty by default.</p>
</td>
</tr>
<tr>
<td>
<p><a href="build-rule.html">buildRule</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">buildRule</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Rule for selecting a dependency build, when not specified <a href="same-chain-or-last-finished.html">sameChainOrLastFinished</a> is used</p>
</td>
</tr>
<tr>
<td>
<p><a href="clean-destination.html">cleanDestination</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">cleanDestination</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>Whether destination directory on agent should be cleaned before copying artifacts, false by default</p>
</td>
</tr>
<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>Allows to disable the dependency, it is enabled by default</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>Dependency id, if not specified will be generated</p>
</td>
</tr>
<tr>
<td>
<p><a href="rules.html">rules</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">rules</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">&lt;</span><a href="../-artifact-rule/index.html"><span class="identifier">ArtifactRule</span></a><span class="symbol">&gt;</span></code>
<p>Typed API for <a href="artifact-rules.html">artifactRules</a></p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="build.html">build</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">build</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.ArtifactDependency$build(kotlin.String)/buildNumber">buildNumber</span><span class="symbol">:</span>&nbsp;<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="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching a build with the specified build number</p>
</td>
</tr>
<tr>
<td>
<p><a href="last-finished.html">lastFinished</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">lastFinished</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.ArtifactDependency$lastFinished(kotlin.String)/branch">branch</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching the last finished build in the specified branch</p>
</td>
</tr>
<tr>
<td>
<p><a href="last-pinned.html">lastPinned</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">lastPinned</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.ArtifactDependency$lastPinned(kotlin.String)/branch">branch</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching a last pinned build in the specified branch</p>
</td>
</tr>
<tr>
<td>
<p><a href="last-successful.html">lastSuccessful</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">lastSuccessful</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.ArtifactDependency$lastSuccessful(kotlin.String)/branch">branch</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching the last successful build in the specified branch</p>
</td>
</tr>
<tr>
<td>
<p><a href="same-chain-or-last-finished.html">sameChainOrLastFinished</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">sameChainOrLastFinished</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching the build from the same build chain or last finished build</p>
</td>
</tr>
<tr>
<td>
<p><a href="tag.html">tag</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">tag</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.ArtifactDependency$tag(kotlin.String, kotlin.String)/tag">tag</span><span class="symbol">:</span>&nbsp;<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.v2018_1.ArtifactDependency$tag(kotlin.String, kotlin.String)/branch">branch</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../-build-rule/index.html"><span class="identifier">BuildRule</span></a></code>
<p>Creates a build rule matching a build with the specified tag in the specified branch</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">ArtifactDependency</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">ArtifactDependency</span></a></code>
<p>Copies the receiver artifact dependency</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>