| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>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="declaration: package: org.apache.storm.container.docker, class: DockerRunCommand"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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 class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/DockerRunCommand.html">Use</a></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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.container.docker</a></div> |
| <h1 title="Class DockerRunCommand" class="title">Class DockerRunCommand</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="DockerCommand.html" title="class in org.apache.storm.container.docker">org.apache.storm.container.docker.DockerCommand</a> |
| <div class="inheritance">org.apache.storm.container.docker.DockerRunCommand</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DockerRunCommand</span> |
| <span class="extends-implements">extends <a href="DockerCommand.html" title="class in org.apache.storm.container.docker">DockerCommand</a></span></div> |
| <div class="block">Encapsulates the docker run command and its command line arguments.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">DockerRunCommand</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> containerName, |
| <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> userInfo, |
| <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> image)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The Construction function.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> paths)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add all readonly locations.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> paths, |
| boolean createSource)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add all readonly locations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> paths)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add all the rw bind mount locations.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> paths, |
| boolean createSource)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add all the rw bind mount locations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> 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> memoryNode)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> 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> destinationDevice)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --device option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> 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> destinationPath)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add readonly bind mout location.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> 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> destinationPath, |
| boolean createSource)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add readonly bind mount location.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> 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> destinationPath)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> 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> destinationPath, |
| boolean createSource)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add bind mount locations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#detachOnRun()" class="member-name-link">detachOnRun</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add -d option.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableDetach()" class="member-name-link">disableDetach</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Disable detach.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableDetach()" class="member-name-link">enableDetach</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable detach.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCommandWithArguments()" class="member-name-link">getCommandWithArguments</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the full command.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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>[] groups)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --group-add option.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeContainerOnExit()" class="member-name-link">removeContainerOnExit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add --rm option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> capabilities)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set capabilities of the container.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> parentPath)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --cgroup-parent option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> cidFile)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the output container id file location.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> workdir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --workdir option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCpus(double)" class="member-name-link">setCpus</a><wbr>(double cpus)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the number of cpus to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCpuShares(int)" class="member-name-link">setCpuShares</a><wbr>(int cpuShares)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set cpuShares.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMemoryMb(int)" class="member-name-link">setMemoryMb</a><wbr>(int memoryMb)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the number of memory in MB to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --net option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNoNewPrivileges()" class="member-name-link">setNoNewPrivileges</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set no-new-privileges option.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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><<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>> overrideCommandWithArgs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set extra commands and args.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPrivileged()" class="member-name-link">setPrivileged</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --privileged option to run a privileged container.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReadonly()" class="member-name-link">setReadonly</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add --read-only option.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> jsonPath)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set --security-opt option.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.container.docker.DockerCommand">Methods inherited from class org.apache.storm.container.docker.<a href="DockerCommand.html" title="class in org.apache.storm.container.docker">DockerCommand</a></h3> |
| <code><a href="DockerCommand.html#addCommandArguments(java.lang.String...)">addCommandArguments</a>, <a href="DockerCommand.html#getCommandOption()">getCommandOption</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>DockerRunCommand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DockerRunCommand</span><wbr><span class="parameters">(<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> containerName, |
| <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> userInfo, |
| <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> image)</span></div> |
| <div class="block">The Construction function.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>containerName</code> - the container name</dd> |
| <dd><code>userInfo</code> - the info of the user, e.g. "uid:gid"</dd> |
| <dd><code>image</code> - the container image</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="removeContainerOnExit()"> |
| <h3>removeContainerOnExit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">removeContainerOnExit</span>()</div> |
| <div class="block">Add --rm option.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="detachOnRun()"> |
| <h3>detachOnRun</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">detachOnRun</span>()</div> |
| <div class="block">Add -d option.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContainerWorkDir(java.lang.String)"> |
| <h3>setContainerWorkDir</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setContainerWorkDir</span><wbr><span class="parameters">(<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> workdir)</span></div> |
| <div class="block">Set --workdir option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workdir</code> - the working directory</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNetworkType(java.lang.String)"> |
| <h3>setNetworkType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setNetworkType</span><wbr><span class="parameters">(<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> type)</span></div> |
| <div class="block">Set --net option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the network type</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addReadWriteMountLocation(java.lang.String,java.lang.String,boolean)"> |
| <h3>addReadWriteMountLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addReadWriteMountLocation</span><wbr><span class="parameters">(<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> 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> destinationPath, |
| boolean createSource)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add bind mount locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourcePath</code> - the source path</dd> |
| <dd><code>destinationPath</code> - the destination path</dd> |
| <dd><code>createSource</code> - if createSource is false and the source path doesn't exist, do nothing</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addReadWriteMountLocation(java.lang.String,java.lang.String)"> |
| <h3>addReadWriteMountLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addReadWriteMountLocation</span><wbr><span class="parameters">(<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> 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> destinationPath)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAllReadWriteMountLocations(java.util.List)"> |
| <h3>addAllReadWriteMountLocations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addAllReadWriteMountLocations</span><wbr><span class="parameters">(<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><<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>> paths)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add all the rw bind mount locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>paths</code> - the locations</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAllReadWriteMountLocations(java.util.List,boolean)"> |
| <h3>addAllReadWriteMountLocations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addAllReadWriteMountLocations</span><wbr><span class="parameters">(<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><<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>> paths, |
| boolean createSource)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add all the rw bind mount locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>paths</code> - the locations</dd> |
| <dd><code>createSource</code> - if createSource is false and the source path doesn't exist, do nothing</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addReadOnlyMountLocation(java.lang.String,java.lang.String,boolean)"> |
| <h3>addReadOnlyMountLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addReadOnlyMountLocation</span><wbr><span class="parameters">(<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> 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> destinationPath, |
| boolean createSource)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add readonly bind mount location.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourcePath</code> - the source path</dd> |
| <dd><code>destinationPath</code> - the destination path</dd> |
| <dd><code>createSource</code> - if createSource is false and the source path doesn't exist, do nothing</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addReadOnlyMountLocation(java.lang.String,java.lang.String)"> |
| <h3>addReadOnlyMountLocation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addReadOnlyMountLocation</span><wbr><span class="parameters">(<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> 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> destinationPath)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add readonly bind mout location.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourcePath</code> - the source path</dd> |
| <dd><code>destinationPath</code> - the destination path</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAllReadOnlyMountLocations(java.util.List)"> |
| <h3>addAllReadOnlyMountLocations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addAllReadOnlyMountLocations</span><wbr><span class="parameters">(<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><<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>> paths)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add all readonly locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>paths</code> - the locations</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAllReadOnlyMountLocations(java.util.List,boolean)"> |
| <h3>addAllReadOnlyMountLocations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addAllReadOnlyMountLocations</span><wbr><span class="parameters">(<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><<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>> paths, |
| boolean createSource)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Add all readonly locations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>paths</code> - the locations</dd> |
| <dd><code>createSource</code> - if createSource is false and the source path doesn't exist, do nothing</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addCpuSetBindings(java.util.List,java.lang.String)"> |
| <h3>addCpuSetBindings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addCpuSetBindings</span><wbr><span class="parameters">(<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><<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>> 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> memoryNode)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCGroupParent(java.lang.String)"> |
| <h3>setCGroupParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setCGroupParent</span><wbr><span class="parameters">(<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> parentPath)</span></div> |
| <div class="block">Set --cgroup-parent option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parentPath</code> - the cgroup parent path</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPrivileged()"> |
| <h3>setPrivileged</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setPrivileged</span>()</div> |
| <div class="block">Set --privileged option to run a privileged container. Use with extreme care.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCapabilities(java.util.Set)"> |
| <h3>setCapabilities</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setCapabilities</span><wbr><span class="parameters">(<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><<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>> capabilities)</span></div> |
| <div class="block">Set capabilities of the container.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>capabilities</code> - the capabilities to be added</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addDevice(java.lang.String,java.lang.String)"> |
| <h3>addDevice</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">addDevice</span><wbr><span class="parameters">(<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> 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> destinationDevice)</span></div> |
| <div class="block">Set --device option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sourceDevice</code> - the source device</dd> |
| <dd><code>destinationDevice</code> - the destination device</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableDetach()"> |
| <h3>enableDetach</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">enableDetach</span>()</div> |
| <div class="block">Enable detach.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disableDetach()"> |
| <h3>disableDetach</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">disableDetach</span>()</div> |
| <div class="block">Disable detach.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="groupAdd(java.lang.String[])"> |
| <h3>groupAdd</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">groupAdd</span><wbr><span class="parameters">(<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>[] groups)</span></div> |
| <div class="block">Set --group-add option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>groups</code> - the groups to be added</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOverrideCommandWithArgs(java.util.List)"> |
| <h3>setOverrideCommandWithArgs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setOverrideCommandWithArgs</span><wbr><span class="parameters">(<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><<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>> overrideCommandWithArgs)</span></div> |
| <div class="block">Set extra commands and args. It can override the existing commands.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>overrideCommandWithArgs</code> - the extra commands and args</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReadonly()"> |
| <h3>setReadonly</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setReadonly</span>()</div> |
| <div class="block">Add --read-only option.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSeccompProfile(java.lang.String)"> |
| <h3>setSeccompProfile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setSeccompProfile</span><wbr><span class="parameters">(<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> jsonPath)</span></div> |
| <div class="block">Set --security-opt option.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>jsonPath</code> - the path to the json file</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNoNewPrivileges()"> |
| <h3>setNoNewPrivileges</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setNoNewPrivileges</span>()</div> |
| <div class="block">Set no-new-privileges option.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCpuShares(int)"> |
| <h3>setCpuShares</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setCpuShares</span><wbr><span class="parameters">(int cpuShares)</span></div> |
| <div class="block">Set cpuShares.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cpuShares</code> - the cpu shares</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCpus(double)"> |
| <h3>setCpus</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setCpus</span><wbr><span class="parameters">(double cpus)</span></div> |
| <div class="block">Set the number of cpus to use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cpus</code> - the number of cpus</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMemoryMb(int)"> |
| <h3>setMemoryMb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setMemoryMb</span><wbr><span class="parameters">(int memoryMb)</span></div> |
| <div class="block">Set the number of memory in MB to use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>memoryMb</code> - the number of memory in MB</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCidFile(java.lang.String)"> |
| <h3>setCidFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DockerRunCommand.html" title="class in org.apache.storm.container.docker">DockerRunCommand</a></span> <span class="element-name">setCidFile</span><wbr><span class="parameters">(<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> cidFile)</span></div> |
| <div class="block">Set the output container id file location.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cidFile</code> - the container id file</dd> |
| <dt>Returns:</dt> |
| <dd>the self</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCommandWithArguments()"> |
| <h3>getCommandWithArguments</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getCommandWithArguments</span>()</div> |
| <div class="block">Get the full command.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="DockerCommand.html#getCommandWithArguments()">getCommandWithArguments</a></code> in class <code><a href="DockerCommand.html" title="class in org.apache.storm.container.docker">DockerCommand</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the full command</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |