| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.16) on Sun Oct 23 14:10:58 GMT 2022 --> |
| <title>Config.Builder (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-10-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Config.Builder (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All 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>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.Builder" class="title">Class Config.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.streamlet.Config.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="Config.html" title="class in org.apache.heron.streamlet">Config</a></dd> |
| </dl> |
| <hr> |
| <pre>public static final class <span class="typeNameLabel">Config.Builder</span> |
| extends java.lang.Object</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <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="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><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="#build()">build</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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="#setDeliverySemantics(org.apache.heron.streamlet.Config.DeliverySemantics)">setDeliverySemantics</a></span>​(<a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a> semantics)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the delivery semantics of the topology</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><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="#setNumContainers(int)">setNumContainers</a></span>​(int numContainers)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the number of containers to run this topology</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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="#setPerContainerCpu(double)">setPerContainerCpu</a></span>​(double perContainerCpu)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the per-container (per-instance) CPU to be used by this topology</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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="#setPerContainerRam(long)">setPerContainerRam</a></span>​(long perContainerRam)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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="#setPerContainerRamInBytes(long)">setPerContainerRamInBytes</a></span>​(long perContainerRam)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology as a number of bytes</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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="#setPerContainerRamInGigabytes(long)">setPerContainerRamInGigabytes</a></span>​(long perContainerRamGB)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology in gigabytes</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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="#setPerContainerRamInMegabytes(long)">setPerContainerRamInMegabytes</a></span>​(long perContainerRamMB)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology in megabytes</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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="#setSerializer(org.apache.heron.streamlet.Config.Serializer)">setSerializer</a></span>​(<a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a> topologySerializer)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet"><code>Config.Serializer</code></a> to be used by the topology (current options are <code>KryoSerializer</code> and the native Java serializer.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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="#setUserConfig(java.lang.String,java.lang.Object)">setUserConfig</a></span>​(java.lang.String key, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets some user-defined key/value mapping</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 role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setPerContainerCpu(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPerContainerCpu</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setPerContainerCpu​(double perContainerCpu)</pre> |
| <div class="block">Sets the per-container (per-instance) CPU to be used by this topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>perContainerCpu</code> - Per-container (per-instance) CPU as a double</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPerContainerRam(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPerContainerRam</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setPerContainerRam​(long perContainerRam)</pre> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>perContainerRam</code> - Per-container (per-instance) RAM expressed as a Long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPerContainerRamInBytes(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPerContainerRamInBytes</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setPerContainerRamInBytes​(long perContainerRam)</pre> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology as a number of bytes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>perContainerRam</code> - Per-container (per-instance) RAM expressed as a Long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPerContainerRamInMegabytes(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPerContainerRamInMegabytes</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setPerContainerRamInMegabytes​(long perContainerRamMB)</pre> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology in megabytes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>perContainerRamMB</code> - Per-container (per-instance) RAM expressed as a Long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPerContainerRamInGigabytes(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPerContainerRamInGigabytes</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setPerContainerRamInGigabytes​(long perContainerRamGB)</pre> |
| <div class="block">Sets the per-container (per-instance) RAM to be used by this topology in gigabytes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>perContainerRamGB</code> - Per-container (per-instance) RAM expressed as a Long.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNumContainers(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumContainers</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setNumContainers​(int numContainers)</pre> |
| <div class="block">Sets the number of containers to run this topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numContainers</code> - The number of containers across which to distribute this topology</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDeliverySemantics(org.apache.heron.streamlet.Config.DeliverySemantics)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeliverySemantics</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setDeliverySemantics​(<a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a> semantics)</pre> |
| <div class="block">Sets the delivery semantics of the topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>semantics</code> - The delivery semantic to be enforced</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUserConfig(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserConfig</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setUserConfig​(java.lang.String key, |
| java.lang.Object value)</pre> |
| <div class="block">Sets some user-defined key/value mapping</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The user-defined key</dd> |
| <dd><code>value</code> - The user-defined value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSerializer(org.apache.heron.streamlet.Config.Serializer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSerializer</h4> |
| <pre class="methodSignature">public <a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a> setSerializer​(<a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a> topologySerializer)</pre> |
| <div class="block">Sets the <a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet"><code>Config.Serializer</code></a> to be used by the topology (current options are <code>KryoSerializer</code> and the native Java serializer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topologySerializer</code> - The data serializer to use for streamlet elements in the topology.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="build()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre class="methodSignature">public <a href="Config.html" title="class in org.apache.heron.streamlet">Config</a> build()</pre> |
| </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>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> |