blob: d7c018685ca52d53d3f52a08329d7bee24033ba0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.storm.container.docker.DockerRunCommand (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.storm.container.docker, class: DockerRunCommand">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">Class</a></li>
<li class="nav-bar-cell1-rev">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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.storm.container.docker.DockerRunCommand" class="title">Uses of Class<br>org.apache.storm.container.docker.DockerRunCommand</h1>
</div>
<div class="caption"><span>Packages that use <a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.container.docker">org.apache.storm.container.docker</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.container.docker">
<h2>Uses of <a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a> in <a href="../package-summary.html">org.apache.storm.container.docker</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.container.docker</a> that return <a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addAllReadOnlyMountLocations(java.util.List)" class="member-name-link">addAllReadOnlyMountLocations</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;paths)</code></div>
<div class="col-last even-row-color">
<div class="block">Add all readonly locations.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addAllReadOnlyMountLocations(java.util.List,boolean)" class="member-name-link">addAllReadOnlyMountLocations</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;paths,
boolean&nbsp;createSource)</code></div>
<div class="col-last odd-row-color">
<div class="block">Add all readonly locations.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addAllReadWriteMountLocations(java.util.List)" class="member-name-link">addAllReadWriteMountLocations</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;paths)</code></div>
<div class="col-last even-row-color">
<div class="block">Add all the rw bind mount locations.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addAllReadWriteMountLocations(java.util.List,boolean)" class="member-name-link">addAllReadWriteMountLocations</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;paths,
boolean&nbsp;createSource)</code></div>
<div class="col-last odd-row-color">
<div class="block">Add all the rw bind mount locations.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addCpuSetBindings(java.util.List,java.lang.String)" class="member-name-link">addCpuSetBindings</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;cores,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;memoryNode)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addDevice(java.lang.String,java.lang.String)" class="member-name-link">addDevice</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourceDevice,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationDevice)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set --device option.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addReadOnlyMountLocation(java.lang.String,java.lang.String)" class="member-name-link">addReadOnlyMountLocation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourcePath,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationPath)</code></div>
<div class="col-last even-row-color">
<div class="block">Add readonly bind mout location.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addReadOnlyMountLocation(java.lang.String,java.lang.String,boolean)" class="member-name-link">addReadOnlyMountLocation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourcePath,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationPath,
boolean&nbsp;createSource)</code></div>
<div class="col-last odd-row-color">
<div class="block">Add readonly bind mount location.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addReadWriteMountLocation(java.lang.String,java.lang.String)" class="member-name-link">addReadWriteMountLocation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourcePath,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationPath)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#addReadWriteMountLocation(java.lang.String,java.lang.String,boolean)" class="member-name-link">addReadWriteMountLocation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourcePath,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;destinationPath,
boolean&nbsp;createSource)</code></div>
<div class="col-last odd-row-color">
<div class="block">Add bind mount locations.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#detachOnRun()" class="member-name-link">detachOnRun</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Add -d option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#disableDetach()" class="member-name-link">disableDetach</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Disable detach.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#enableDetach()" class="member-name-link">enableDetach</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Enable detach.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#groupAdd(java.lang.String%5B%5D)" class="member-name-link">groupAdd</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;groups)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set --group-add option.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#removeContainerOnExit()" class="member-name-link">removeContainerOnExit</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Add --rm option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setCapabilities(java.util.Set)" class="member-name-link">setCapabilities</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;capabilities)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set capabilities of the container.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setCGroupParent(java.lang.String)" class="member-name-link">setCGroupParent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;parentPath)</code></div>
<div class="col-last even-row-color">
<div class="block">Set --cgroup-parent option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setCidFile(java.lang.String)" class="member-name-link">setCidFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;cidFile)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the output container id file location.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setContainerWorkDir(java.lang.String)" class="member-name-link">setContainerWorkDir</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;workdir)</code></div>
<div class="col-last even-row-color">
<div class="block">Set --workdir option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setCpus(double)" class="member-name-link">setCpus</a><wbr>(double&nbsp;cpus)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the number of cpus to use.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setCpuShares(int)" class="member-name-link">setCpuShares</a><wbr>(int&nbsp;cpuShares)</code></div>
<div class="col-last even-row-color">
<div class="block">Set cpuShares.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setMemoryMb(int)" class="member-name-link">setMemoryMb</a><wbr>(int&nbsp;memoryMb)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the number of memory in MB to use.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setNetworkType(java.lang.String)" class="member-name-link">setNetworkType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;type)</code></div>
<div class="col-last even-row-color">
<div class="block">Set --net option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setNoNewPrivileges()" class="member-name-link">setNoNewPrivileges</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Set no-new-privileges option.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setOverrideCommandWithArgs(java.util.List)" class="member-name-link">setOverrideCommandWithArgs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;overrideCommandWithArgs)</code></div>
<div class="col-last even-row-color">
<div class="block">Set extra commands and args.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setPrivileged()" class="member-name-link">setPrivileged</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Set --privileged option to run a privileged container.</div>
</div>
<div class="col-first even-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setReadonly()" class="member-name-link">setReadonly</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Add --read-only option.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">DockerRunCommand.</span><code><a href="../DockerRunCommand.html#setSeccompProfile(java.lang.String)" class="member-name-link">setSeccompProfile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;jsonPath)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set --security-opt option.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>