blob: 521274bd1cf741b3660caa952c31b92541844117 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>AbstractPacking (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="AbstractPacking (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.heron.packing</a></div>
<h2 title="Class AbstractPacking" class="title">Class AbstractPacking</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.packing.AbstractPacking</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></code>, <code><a href="../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="binpacking/FirstFitDecreasingPacking.html" title="class in org.apache.heron.packing.binpacking">FirstFitDecreasingPacking</a></code>, <code><a href="roundrobin/ResourceCompliantRRPacking.html" title="class in org.apache.heron.packing.roundrobin">ResourceCompliantRRPacking</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractPacking</span>
extends java.lang.Object
implements <a href="../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a>, <a href="../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></pre>
<div class="block">Common configuration finalization for packing algorithms
Packing algorithms that extend this class should assume that:
<p>
1. Instance default resources are read from:
heron.resources.instance.ram,
heron.resources.instance.cpu,
heron.resources.instance.disk
<p>
2. Padding resource percentage is read from:
topology.container.padding.percentage
or taken from PackingUtils.DEFAULT_CONTAINER_PADDING_PERCENTAGE
<p>
3. Padding resource values are read from:
topology.container.ram.padding or taken from PackingUtils.DEFAULT_CONTAINER_RAM_PADDING,
topology.container.cpu.padding or taken from PackingUtils.DEFAULT_CONTAINER_CPU_PADDING
<p>
4. Max number of instances per container is read from:
topology.container.max.instances
or taken from PackingUtils.DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER
<p>
5. Container resources requirements are read from:
topology.container.cpu or calculated from maxNumInstancesPerContainer * instanceDefaultCpu
topology.container.ram or calculated from maxNumInstancesPerContainer * instanceDefaultRam
topology.container.disk or calculated from maxNumInstancesPerContainer * instanceDefaultDisk
<p>
6. Padding resource is finalized by:
Math.max(containerResource * paddingPercentage, paddingValue)
<p>
Subclasses that extend this class should just need to create PackingPlanBuilder with:
defaultInstanceResource,
maxContainerResource,
containerPadding,
componentResourceMap,
instanceConstraints,
and packingConstraints set.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#componentResourceMap">componentResourceMap</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultInstanceResources">defaultInstanceResources</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxContainerResources">maxContainerResources</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxNumInstancesPerContainer">maxNumInstancesPerContainer</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#padding">padding</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#topology">topology</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== 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">&nbsp;</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()">AbstractPacking</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">This is to for disposing or cleaning up any internal state accumulated by
the uploader</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></span>&#8203;(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;config,
<a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;inputTopology)</code></th>
<td class="colLast">
<div class="block">Initialize the packing algorithm with the static config and the topology</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.spi.packing.IPacking">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.heron.spi.packing.<a href="../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></h3>
<code><a href="../spi/packing/IPacking.html#pack()">pack</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.spi.packing.IRepacking">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.heron.spi.packing.<a href="../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></h3>
<code><a href="../spi/packing/IRepacking.html#repack(org.apache.heron.spi.packing.PackingPlan,int,java.util.Map)">repack</a>, <a href="../spi/packing/IRepacking.html#repack(org.apache.heron.spi.packing.PackingPlan,java.util.Map)">repack</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="topology">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topology</h4>
<pre>protected&nbsp;<a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology</pre>
</li>
</ul>
<a id="defaultInstanceResources">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultInstanceResources</h4>
<pre>protected&nbsp;<a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> defaultInstanceResources</pre>
</li>
</ul>
<a id="maxContainerResources">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxContainerResources</h4>
<pre>protected&nbsp;<a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> maxContainerResources</pre>
</li>
</ul>
<a id="maxNumInstancesPerContainer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxNumInstancesPerContainer</h4>
<pre>protected&nbsp;int maxNumInstancesPerContainer</pre>
</li>
</ul>
<a id="componentResourceMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>componentResourceMap</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&gt; componentResourceMap</pre>
</li>
</ul>
<a id="padding">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>padding</h4>
<pre>protected&nbsp;<a href="../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> padding</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPacking</h4>
<pre>public&nbsp;AbstractPacking()</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="initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initialize&#8203;(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;config,
<a href="../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;inputTopology)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../spi/packing/IPacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">IPacking</a></code></span></div>
<div class="block">Initialize the packing algorithm with the static config and the topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../spi/packing/IPacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../spi/packing/IRepacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - topology config</dd>
<dd><code>inputTopology</code> - topology to repack</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../spi/packing/IPacking.html#close()">IPacking</a></code></span></div>
<div class="block">This is to for disposing or cleaning up any internal state accumulated by
the uploader
<p>
Closes this stream and releases any system resources associated
with it. If the stream is already closed then invoking this
method has no effect.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../spi/packing/IPacking.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../spi/packing/IRepacking.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>