Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / lib / docker / class-use / DockerRun.html
blob: d86583298edb0e1de22ac764a7c7c49edeabfa60 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:14 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.eclipse.mosaic.lib.docker.DockerRun (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class org.eclipse.mosaic.lib.docker.DockerRun (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/docker/class-use/DockerRun.html" target="_top">Frames</a></li>
<li><a href="DockerRun.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.eclipse.mosaic.lib.docker.DockerRun" class="title">Uses of Class<br>org.eclipse.mosaic.lib.docker.DockerRun</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.eclipse.mosaic.lib.docker">org.eclipse.mosaic.lib.docker</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.eclipse.mosaic.lib.docker">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a> in <a href="../../../../../../org/eclipse/mosaic/lib/docker/package-summary.html">org.eclipse.mosaic.lib.docker</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/eclipse/mosaic/lib/docker/package-summary.html">org.eclipse.mosaic.lib.docker</a> that return <a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#name-java.lang.String-">name</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Used to set the containers name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#parameter-java.lang.String-java.lang.Object-">parameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Adds an environmental parameter to the docker run command.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#portBinding-int-int-">portBinding</a></span>(int&nbsp;portHost,
int&nbsp;portContainer)</code>
<div class="block">Adds an explicit port binding to this docker run command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#removeAfterRun--">removeAfterRun</a></span>()</code>
<div class="block">Marks the docker container to be removed after it has been run.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#removeBeforeRun--">removeBeforeRun</a></span>()</code>
<div class="block">If containers with the same name are already running, this method
marks those containers to be removed beforehand.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerClient.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerClient.html#run-java.lang.String-">run</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;image)</code>
<div class="block">Compose a docker run command by calling this method, building your command, and eventually calling <a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#execute--"><code>execute()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">DockerRun</a></code></td>
<td class="colLast"><span class="typeNameLabel">DockerRun.</span><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html#volumeBinding-java.io.File-java.lang.String-">volumeBinding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;localDir,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;volumePath)</code>
<div class="block">Adds an explicit volume binding this docker run command.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/docker/DockerRun.html" title="class in org.eclipse.mosaic.lib.docker">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/docker/class-use/DockerRun.html" target="_top">Frames</a></li>
<li><a href="DockerRun.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>