199 lines
13 KiB
HTML
199 lines
13 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>DockerCommandStep - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps</a> / <a href="./index.html">DockerCommandStep</a><br/>
|
|
<br/>
|
|
<h1>DockerCommandStep</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">DockerCommandStep</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/docker.html#Docker-DockerCommand">build step</a> for a generic docker command runner (can run Docker build, push, other...)</p>
|
|
<p><strong>See Also</strong><br/>
|
|
<p><a href="../docker-command.html">dockerCommand</a></p>
|
|
</p>
|
|
<h3>Types</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-command-type/index.html">CommandType</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">CommandType</span> <span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-compound-param/index.html"><span class="identifier">CompoundParam</span></a><span class="symbol"><</span><a href="-command-type/index.html"><span class="identifier">CommandType</span></a><span class="symbol">></span></code></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">DockerCommandStep</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">DockerCommandStep</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">DockerCommandStep</span><span class="symbol">(</span><span class="symbol">)</span></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/docker.html#Docker-DockerCommand">build step</a> for a generic docker command runner (can run Docker build, push, other...)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="command-type.html">commandType</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">commandType</span><span class="symbol">: </span><a href="-command-type/index.html"><span class="identifier">CommandType</span></a><span class="symbol">?</span></code>
|
|
<p>Specifies the type of the command, at the moment "build", "push", "other"</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/conditions.html">conditions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">conditions</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2017_2/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a></code>
|
|
<p>Optional collection of build step execution conditions</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/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 step is enabled, true by default</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/execution-mode.html">executionMode</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">executionMode</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/-execution-mode/index.html"><span class="identifier">ExecutionMode</span></a></code>
|
|
<p>Build step <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/-execution-mode/index.html">execution mode</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/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>Id of the step, if not specified will be generated</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/name.html">name</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">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></code>
|
|
<p>Build step name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/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 step type</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.buildSteps.DockerCommandStep$build(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep.CommandType.Build, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-command-type/-build/index.html"><span class="identifier">Build</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="symbol">: </span><a href="-command-type/-build/index.html"><span class="identifier">Build</span></a></code>
|
|
<p>Run "docker build" command</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="other.html">other</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">other</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep$other(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep.CommandType.Other, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-command-type/-other/index.html"><span class="identifier">Other</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="symbol">: </span><a href="-command-type/-other/index.html"><span class="identifier">Other</span></a></code>
|
|
<p>Run a specified docker command</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="push.html">push</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">push</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep$push(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2018_1.buildSteps.DockerCommandStep.CommandType.Push, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="-command-type/-push/index.html"><span class="identifier">Push</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="symbol">: </span><a href="-command-type/-push/index.html"><span class="identifier">Push</span></a></code>
|
|
<p>Run "docker push" command</p>
|
|
</td>
|
|
</tr>
|
|
<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_1.buildSteps.DockerCommandStep$validate(jetbrains.buildServer.configs.kotlin.v2018_1.ErrorConsumer)/consumer">consumer</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-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_1/-build-step/clear-conditions.html">clearConditions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">clearConditions</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></code>
|
|
<p>Deletes all configured build step conditions</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/conditions.html">conditions</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">conditions</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2018_1.BuildStep$conditions(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v2017_2.BuildStepConditions, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="../../jetbrains.build-server.configs.kotlin.v2017_2/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
|
|
<p>Configures <a href="https://www.jetbrains.com/help/teamcity/?Build+Step+Conditions">build step conditions</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v2018_1/-build-step/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_1/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
|
|
<p>Creates an instance of this build step 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_1/-build-step/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>
|