| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>Config (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="Config (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9}; |
| 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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.streamlet</a></div> |
| <h2 title="Class Config" class="title">Class Config</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.streamlet.Config</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">Config</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block">Config is the way users configure the execution of the topology. |
| Things like streamlet delivery semantics, resources used, as well as |
| user-defined key/value pairs are passed on to the topology runner via |
| this class.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.heron.streamlet.Config">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An enum encapsulating the delivery semantics that can be applied to Heron topologies.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An enum encapsulating the serializers that can be used for data in the topology.</div> |
| </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>static <a href="Config.html" title="class in org.apache.heron.streamlet">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultConfig()">defaultConfig</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the topology to use the default configuration: 100 megabytes of RAM per container, 1.0 |
| CPUs per container, at-most-once delivery semantics, and the Kryo serializer.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeliverySemantics()">getDeliverySemantics</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the delivery semantics applied to the topology</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../api/Config.html" title="class in org.apache.heron.api">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeronConfig()">getHeronConfig</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerContainerCpu()">getPerContainerCpu</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the CPU used per topology container</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerContainerRam()">getPerContainerRam</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the RAM used per topology container as a number of bytes</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerContainerRamAsBytes()">getPerContainerRamAsBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the RAM used per topology container as a number of bytes</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerContainerRamAsGigabytes()">getPerContainerRamAsGigabytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the RAM used per topology container as a number of gigabytes</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerContainerRamAsMegabytes()">getPerContainerRamAsMegabytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the RAM used per topology container as a number of megabytes</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSerializer()">getSerializer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the serializer used by the topology</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBuilder()">newBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new <a href="Config.Builder.html" title="class in org.apache.heron.streamlet"><code>Config.Builder</code></a> that can be used to create a configuration object for Streamlet |
| API topologies</div> |
| </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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="defaultConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultConfig</h4> |
| <pre class="methodSignature">public static <a href="Config.html" title="class in org.apache.heron.streamlet">Config</a> defaultConfig()</pre> |
| <div class="block">Sets the topology to use the default configuration: 100 megabytes of RAM per container, 1.0 |
| CPUs per container, at-most-once delivery semantics, and the Kryo serializer.</div> |
| </li> |
| </ul> |
| <a id="newBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBuilder</h4> |
| <pre class="methodSignature">public static <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> newBuilder()</pre> |
| <div class="block">Returns a new <a href="Config.Builder.html" title="class in org.apache.heron.streamlet"><code>Config.Builder</code></a> that can be used to create a configuration object for Streamlet |
| API topologies</div> |
| </li> |
| </ul> |
| <a id="getHeronConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeronConfig</h4> |
| <pre class="methodSignature">public <a href="../api/Config.html" title="class in org.apache.heron.api">Config</a> getHeronConfig()</pre> |
| </li> |
| </ul> |
| <a id="getPerContainerCpu()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerContainerCpu</h4> |
| <pre class="methodSignature">public double getPerContainerCpu()</pre> |
| <div class="block">Gets the CPU used per topology container</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the per-container CPU as a double</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerContainerRam()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerContainerRam</h4> |
| <pre class="methodSignature">public long getPerContainerRam()</pre> |
| <div class="block">Gets the RAM used per topology container as a number of bytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the per-container RAM in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerContainerRamAsBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerContainerRamAsBytes</h4> |
| <pre class="methodSignature">public long getPerContainerRamAsBytes()</pre> |
| <div class="block">Gets the RAM used per topology container as a number of bytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the per-container RAM in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerContainerRamAsMegabytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerContainerRamAsMegabytes</h4> |
| <pre class="methodSignature">public long getPerContainerRamAsMegabytes()</pre> |
| <div class="block">Gets the RAM used per topology container as a number of megabytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the per-container RAM in megabytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerContainerRamAsGigabytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerContainerRamAsGigabytes</h4> |
| <pre class="methodSignature">public long getPerContainerRamAsGigabytes()</pre> |
| <div class="block">Gets the RAM used per topology container as a number of gigabytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the per-container RAM in gigabytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeliverySemantics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeliverySemantics</h4> |
| <pre class="methodSignature">public <a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a> getDeliverySemantics()</pre> |
| <div class="block">Gets the delivery semantics applied to the topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the delivery semantics as an enum</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSerializer()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSerializer</h4> |
| <pre class="methodSignature">public <a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a> getSerializer()</pre> |
| <div class="block">Gets the serializer used by the topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serializer as an enum</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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
