| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>SubmitterMain (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SubmitterMain (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.scheduler</a></div> |
| <h2 title="Class SubmitterMain" class="title">Class SubmitterMain</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.scheduler.SubmitterMain</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SubmitterMain</span> |
| extends java.lang.Object</pre> |
| <div class="block">Calls Uploader to upload topology package, and Launcher to launch Scheduler.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">SubmitterMain</a></span>​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callLauncherRunner(org.apache.heron.spi.common.Config)">callLauncherRunner</a></span>​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commandLineConfigs(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,org.apache.heron.common.basics.DryRunFormatType,java.lang.Boolean,java.lang.Boolean)">commandLineConfigs</a></span>​(java.lang.String cluster, |
| java.lang.String role, |
| java.lang.String environ, |
| java.lang.String submitUser, |
| java.lang.Boolean dryRun, |
| <a href="../common/basics/DryRunFormatType.html" title="enum in org.apache.heron.common.basics">DryRunFormatType</a> dryRunFormat, |
| java.lang.Boolean verbose, |
| java.lang.Boolean verboseGC)</code></th> |
| <td class="colLast"> |
| <div class="block">Load the config parameters from the command line</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadConfig(org.apache.commons.cli.CommandLine,org.apache.heron.api.generated.TopologyAPI.Topology)">loadConfig</a></span>​(org.apache.commons.cli.CommandLine cmd, |
| <a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#main(java.lang.String%5B%5D)">main</a></span>​(java.lang.String[] args)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#submitTopology()">submitTopology</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Submit a topology |
| 1.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#uploadPackage(org.apache.heron.spi.uploader.IUploader)">uploadPackage</a></span>​(<a href="../spi/uploader/IUploader.html" title="interface in org.apache.heron.spi.uploader">IUploader</a> uploader)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateSubmit(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor,java.lang.String)">validateSubmit</a></span>​(<a href="../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SubmitterMain</h4> |
| <pre>public SubmitterMain​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="commandLineConfigs(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Boolean,org.apache.heron.common.basics.DryRunFormatType,java.lang.Boolean,java.lang.Boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandLineConfigs</h4> |
| <pre class="methodSignature">protected static <a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> commandLineConfigs​(java.lang.String cluster, |
| java.lang.String role, |
| java.lang.String environ, |
| java.lang.String submitUser, |
| java.lang.Boolean dryRun, |
| <a href="../common/basics/DryRunFormatType.html" title="enum in org.apache.heron.common.basics">DryRunFormatType</a> dryRunFormat, |
| java.lang.Boolean verbose, |
| java.lang.Boolean verboseGC)</pre> |
| <div class="block">Load the config parameters from the command line</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cluster</code> - name of the cluster</dd> |
| <dd><code>role</code> - user role</dd> |
| <dd><code>environ</code> - user provided environment/tag</dd> |
| <dd><code>submitUser</code> - the submit user</dd> |
| <dd><code>dryRun</code> - run as dry run</dd> |
| <dd><code>dryRunFormat</code> - the dry run format</dd> |
| <dd><code>verbose</code> - enable verbose logging</dd> |
| <dd><code>verboseGC</code> - enable verbose JVM GC logging</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>config the command line config</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadConfig(org.apache.commons.cli.CommandLine,org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadConfig</h4> |
| <pre class="methodSignature">public static <a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> loadConfig​(org.apache.commons.cli.CommandLine cmd, |
| <a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| </li> |
| </ul> |
| <a id="main(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre class="methodSignature">public static void main​(java.lang.String[] args) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="submitTopology()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submitTopology</h4> |
| <pre class="methodSignature">public void submitTopology() |
| throws <a href="TopologySubmissionException.html" title="class in org.apache.heron.scheduler">TopologySubmissionException</a></pre> |
| <div class="block">Submit a topology |
| 1. Instantiate necessary resources |
| 2. Valid whether it is legal to submit a topology |
| 3. Call LauncherRunner</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologySubmissionException.html" title="class in org.apache.heron.scheduler">TopologySubmissionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validateSubmit(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateSubmit</h4> |
| <pre class="methodSignature">protected void validateSubmit​(<a href="../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor, |
| java.lang.String topologyName) |
| throws <a href="TopologySubmissionException.html" title="class in org.apache.heron.scheduler">TopologySubmissionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologySubmissionException.html" title="class in org.apache.heron.scheduler">TopologySubmissionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="uploadPackage(org.apache.heron.spi.uploader.IUploader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uploadPackage</h4> |
| <pre class="methodSignature">protected java.net.URI uploadPackage​(<a href="../spi/uploader/IUploader.html" title="interface in org.apache.heron.spi.uploader">IUploader</a> uploader) |
| throws <a href="../spi/uploader/UploaderException.html" title="class in org.apache.heron.spi.uploader">UploaderException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../spi/uploader/UploaderException.html" title="class in org.apache.heron.spi.uploader">UploaderException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callLauncherRunner(org.apache.heron.spi.common.Config)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>callLauncherRunner</h4> |
| <pre class="methodSignature">protected void callLauncherRunner​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime) |
| throws <a href="../spi/scheduler/LauncherException.html" title="class in org.apache.heron.spi.scheduler">LauncherException</a>, |
| <a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a>, |
| <a href="dryrun/SubmitDryRunResponse.html" title="class in org.apache.heron.scheduler.dryrun">SubmitDryRunResponse</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../spi/scheduler/LauncherException.html" title="class in org.apache.heron.spi.scheduler">LauncherException</a></code></dd> |
| <dd><code><a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></code></dd> |
| <dd><code><a href="dryrun/SubmitDryRunResponse.html" title="class in org.apache.heron.scheduler.dryrun">SubmitDryRunResponse</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |