blob: 7889523c7792ca26641ae9b7fb1ddeb8bb6ac5f5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:15:19 PDT 2017 -->
<title>gobblin.source.workunit (gobblin-api 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="gobblin.source.workunit (gobblin-api 0.11.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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">
<li><a href="../../../gobblin/source/extractor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../gobblin/stream/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;gobblin.source.workunit</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit">WorkUnitBinPacker</a></td>
<td class="colLast">
<div class="block">A bin packing algorithm for packing <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s into <a href="../../../gobblin/source/workunit/MultiWorkUnit.html" title="class in gobblin.source.workunit"><code>MultiWorkUnit</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit">WorkUnitStream</a></td>
<td class="colLast">
<div class="block">A stream of <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s, allows for working with large numbers of work units in a memory-efficient way, as
well as processing infinite streams of work units.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/WorkUnitWeighter.html" title="interface in gobblin.source.workunit">WorkUnitWeighter</a></td>
<td class="colLast">
<div class="block">Provides weights for <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s to use by a <a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit"><code>WorkUnitBinPacker</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/BasicWorkUnitStream.html" title="class in gobblin.source.workunit">BasicWorkUnitStream</a></td>
<td class="colLast">
<div class="block">A basic implementation of <a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit"><code>WorkUnitStream</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/BasicWorkUnitStream.Builder.html" title="class in gobblin.source.workunit">BasicWorkUnitStream.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a></td>
<td class="colLast">
<div class="block">A class representing all the base attributes required by all tables types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/ExtractFactory.html" title="class in gobblin.source.workunit">ExtractFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/ImmutableExtract.html" title="class in gobblin.source.workunit">ImmutableExtract</a></td>
<td class="colLast">
<div class="block">An immutable version of <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/ImmutableWorkUnit.html" title="class in gobblin.source.workunit">ImmutableWorkUnit</a></td>
<td class="colLast">
<div class="block">An immutable version of <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/MultiWorkUnit.html" title="class in gobblin.source.workunit">MultiWorkUnit</a></td>
<td class="colLast">
<div class="block">A class that wraps multiple <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s so they can executed within a single task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a></td>
<td class="colLast">
<div class="block">A logic concept that defines a unit of work or task for extracting a portion of the data
to be pulled in a job run.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/Extract.TableType.html" title="enum in gobblin.source.workunit">Extract.TableType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../gobblin/source/workunit/MissingExtractAttributeException.html" title="class in gobblin.source.workunit">MissingExtractAttributeException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>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">
<li><a href="../../../gobblin/source/extractor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../gobblin/stream/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>