blob: 61829167fb52a0a3e4b6ae6cb8be01236528beb8 [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>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="WorkUnit (gobblin-api 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":42,"i17":42,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><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">
<li><a href="../../../gobblin/source/workunit/MultiWorkUnit.html" title="class in gobblin.source.workunit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/WorkUnit.html" target="_top">Frames</a></li>
<li><a href="WorkUnit.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">gobblin.source.workunit</div>
<h2 title="Class WorkUnit" class="title">Class WorkUnit</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../gobblin/configuration/State.html" title="class in gobblin.configuration">gobblin.configuration.State</a></li>
<li>
<ul class="inheritance">
<li>gobblin.source.workunit.WorkUnit</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../gobblin/compat/hadoop/WritableShim.html" title="interface in gobblin.compat.hadoop">WritableShim</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../gobblin/source/workunit/ImmutableWorkUnit.html" title="class in gobblin.source.workunit">ImmutableWorkUnit</a>, <a href="../../../gobblin/source/workunit/MultiWorkUnit.html" title="class in gobblin.source.workunit">MultiWorkUnit</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">WorkUnit</span>
extends <a href="../../../gobblin/configuration/State.html" title="class in gobblin.configuration">State</a></pre>
<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.
<p>
An instance of this class should contain all the properties an <a href="../../../gobblin/source/extractor/Extractor.html" title="interface in gobblin.source.extractor"><code>Extractor</code></a> needs
to extract the schema and data records.
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#WorkUnit--">WorkUnit</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../gobblin/source/workunit/WorkUnit.html#createEmpty--"><code>createEmpty()</code></a></span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#WorkUnit-gobblin.source.workunit.Extract-">WorkUnit</a></span>(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#WorkUnit-gobblin.configuration.SourceState-gobblin.source.workunit.Extract-">WorkUnit</a></span>(<a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration">SourceState</a>&nbsp;state,
<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Properties in <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> should not be added to a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>. Having each
<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> contain a copy of <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> is a waste of memory. Use <a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-"><code>create(Extract)</code></a>.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#WorkUnit-gobblin.configuration.SourceState-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-">WorkUnit</a></span>(<a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration">SourceState</a>&nbsp;state,
<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract,
<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Properties in <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> should not be added to a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>. Having each
<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> contain a copy of <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> is a waste of memory. Use <a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-"><code>create(Extract, WatermarkInterval)</code></a>.</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#WorkUnit-gobblin.source.workunit.WorkUnit-">WorkUnit</a></span>(<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;other)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../gobblin/source/workunit/WorkUnit.html#copyOf-gobblin.source.workunit.WorkUnit-"><code>copyOf(WorkUnit)</code></a></span></div>
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#copyOf-gobblin.source.workunit.WorkUnit-">copyOf</a></span>(<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;other)</code>
<div class="block">Factory method.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-">create</a></span>(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</code>
<div class="block">Factory method.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-">create</a></span>(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract,
<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</code>
<div class="block">Factory method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#createEmpty--">createEmpty</a></span>()</code>
<div class="block">Factory method.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>com.google.gson.JsonElement</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getExpectedHighWatermark--">getExpectedHighWatermark</a></span>()</code>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> as a <code>JsonElement</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getExpectedHighWatermark-java.lang.Class-">getExpectedHighWatermark</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass)</code>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getExpectedHighWatermark-java.lang.Class-com.google.gson.Gson-">getExpectedHighWatermark</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass,
com.google.gson.Gson&nbsp;gson)</code>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getExtract--">getExtract</a></span>()</code>
<div class="block">Get the <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a> associated with this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getHighWaterMark--">getHighWaterMark</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use the <a href="../../../gobblin/source/workunit/WorkUnit.html#getExpectedHighWatermark--"><code>getExpectedHighWatermark()</code></a> method.</span></div>
</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>com.google.gson.JsonElement</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWatermark--">getLowWatermark</a></span>()</code>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> as a <code>JsonElement</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWaterMark--">getLowWaterMark</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use the <a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWatermark--"><code>getLowWatermark()</code></a> method.</span></div>
</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWatermark-java.lang.Class-">getLowWatermark</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass)</code>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWatermark-java.lang.Class-com.google.gson.Gson-">getLowWatermark</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass,
com.google.gson.Gson&nbsp;gson)</code>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#readFields-java.io.DataInput-">readFields</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;in)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#setHighWaterMark-long-">setHighWaterMark</a></span>(long&nbsp;highWaterMark)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../gobblin/source/workunit/WorkUnit.html#setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-"><code>setWatermarkInterval(WatermarkInterval)</code></a>.</span></div>
</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#setLowWaterMark-long-">setLowWaterMark</a></span>(long&nbsp;lowWaterMark)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../gobblin/source/workunit/WorkUnit.html#setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-"><code>setWatermarkInterval(WatermarkInterval)</code></a>.</span></div>
</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-">setWatermarkInterval</a></span>(<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</code>
<div class="block">Set <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a> for a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#skip--">skip</a></span>()</code>
<div class="block">This method will allow a work unit to be skipped if needed.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnit.html#write-java.io.DataOutput-">write</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a>&nbsp;out)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.configuration.State">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.configuration.<a href="../../../gobblin/configuration/State.html" title="class in gobblin.configuration">State</a></h3>
<code><a href="../../../gobblin/configuration/State.html#addAll-java.util.Properties-">addAll</a>, <a href="../../../gobblin/configuration/State.html#addAll-gobblin.configuration.State-">addAll</a>, <a href="../../../gobblin/configuration/State.html#addAllIfNotExist-java.util.Properties-">addAllIfNotExist</a>, <a href="../../../gobblin/configuration/State.html#addAllIfNotExist-gobblin.configuration.State-">addAllIfNotExist</a>, <a href="../../../gobblin/configuration/State.html#appendToListProp-java.lang.String-java.lang.String-">appendToListProp</a>, <a href="../../../gobblin/configuration/State.html#appendToSetProp-java.lang.String-java.lang.String-">appendToSetProp</a>, <a href="../../../gobblin/configuration/State.html#contains-java.lang.String-">contains</a>, <a href="../../../gobblin/configuration/State.html#getId--">getId</a>, <a href="../../../gobblin/configuration/State.html#getProp-java.lang.String-">getProp</a>, <a href="../../../gobblin/configuration/State.html#getProp-java.lang.String-java.lang.String-">getProp</a>, <a href="../../../gobblin/configuration/State.html#getPropAsBoolean-java.lang.String-">getPropAsBoolean</a>, <a href="../../../gobblin/configuration/State.html#getPropAsBoolean-java.lang.String-boolean-">getPropAsBoolean</a>, <a href="../../../gobblin/configuration/State.html#getPropAsCaseInsensitiveSet-java.lang.String-">getPropAsCaseInsensitiveSet</a>, <a href="../../../gobblin/configuration/State.html#getPropAsCaseInsensitiveSet-java.lang.String-java.lang.String-">getPropAsCaseInsensitiveSet</a>, <a href="../../../gobblin/configuration/State.html#getPropAsDouble-java.lang.String-">getPropAsDouble</a>, <a href="../../../gobblin/configuration/State.html#getPropAsDouble-java.lang.String-double-">getPropAsDouble</a>, <a href="../../../gobblin/configuration/State.html#getPropAsInt-java.lang.String-">getPropAsInt</a>, <a href="../../../gobblin/configuration/State.html#getPropAsInt-java.lang.String-int-">getPropAsInt</a>, <a href="../../../gobblin/configuration/State.html#getPropAsJsonArray-java.lang.String-">getPropAsJsonArray</a>, <a href="../../../gobblin/configuration/State.html#getPropAsList-java.lang.String-">getPropAsList</a>, <a href="../../../gobblin/configuration/State.html#getPropAsList-java.lang.String-java.lang.String-">getPropAsList</a>, <a href="../../../gobblin/configuration/State.html#getPropAsLong-java.lang.String-">getPropAsLong</a>, <a href="../../../gobblin/configuration/State.html#getPropAsLong-java.lang.String-long-">getPropAsLong</a>, <a href="../../../gobblin/configuration/State.html#getPropAsSet-java.lang.String-">getPropAsSet</a>, <a href="../../../gobblin/configuration/State.html#getPropAsSet-java.lang.String-java.lang.String-">getPropAsSet</a>, <a href="../../../gobblin/configuration/State.html#getPropAsShort-java.lang.String-">getPropAsShort</a>, <a href="../../../gobblin/configuration/State.html#getPropAsShort-java.lang.String-short-">getPropAsShort</a>, <a href="../../../gobblin/configuration/State.html#getPropAsShortWithRadix-java.lang.String-int-">getPropAsShortWithRadix</a>, <a href="../../../gobblin/configuration/State.html#getPropAsShortWithRadix-java.lang.String-short-int-">getPropAsShortWithRadix</a>, <a href="../../../gobblin/configuration/State.html#getProperties--">getProperties</a>, <a href="../../../gobblin/configuration/State.html#getProperty-java.lang.String-">getProperty</a>, <a href="../../../gobblin/configuration/State.html#getProperty-java.lang.String-java.lang.String-">getProperty</a>, <a href="../../../gobblin/configuration/State.html#getPropertyNames--">getPropertyNames</a>, <a href="../../../gobblin/configuration/State.html#overrideWith-java.util.Properties-">overrideWith</a>, <a href="../../../gobblin/configuration/State.html#overrideWith-gobblin.configuration.State-">overrideWith</a>, <a href="../../../gobblin/configuration/State.html#removeProp-java.lang.String-">removeProp</a>, <a href="../../../gobblin/configuration/State.html#setId-java.lang.String-">setId</a>, <a href="../../../gobblin/configuration/State.html#setProp-java.lang.String-java.lang.Object-">setProp</a>, <a href="../../../gobblin/configuration/State.html#setProps-java.util.Properties-java.util.Properties-">setProps</a>, <a href="../../../gobblin/configuration/State.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WorkUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WorkUnit</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;WorkUnit()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../gobblin/source/workunit/WorkUnit.html#createEmpty--"><code>createEmpty()</code></a></span></div>
<div class="block">Default constructor.</div>
</li>
</ul>
<a name="WorkUnit-gobblin.configuration.SourceState-gobblin.source.workunit.Extract-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WorkUnit</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;WorkUnit(<a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration">SourceState</a>&nbsp;state,
<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Properties in <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> should not be added to a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>. Having each
<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> contain a copy of <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> is a waste of memory. Use <a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-"><code>create(Extract)</code></a>.</span></div>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - a <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> the properties of which will be copied into this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> instance</dd>
<dd><code>extract</code> - an <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a></dd>
</dl>
</li>
</ul>
<a name="WorkUnit-gobblin.configuration.SourceState-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WorkUnit</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;WorkUnit(<a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration">SourceState</a>&nbsp;state,
<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract,
<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Properties in <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> should not be added to a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>. Having each
<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> contain a copy of <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> is a waste of memory. Use <a href="../../../gobblin/source/workunit/WorkUnit.html#create-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-"><code>create(Extract, WatermarkInterval)</code></a>.</span></div>
<div class="block">Constructor for a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> given a <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a>, <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a>, and a <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - a <a href="../../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><code>SourceState</code></a> the properties of which will be copied into this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> instance.</dd>
<dd><code>extract</code> - an <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a>.</dd>
<dd><code>watermarkInterval</code> - a <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a> which defines the range of data this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> will process.</dd>
</dl>
</li>
</ul>
<a name="WorkUnit-gobblin.source.workunit.Extract-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WorkUnit</h4>
<pre>public&nbsp;WorkUnit(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extract</code> - a <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a> object</dd>
</dl>
</li>
</ul>
<a name="WorkUnit-gobblin.source.workunit.WorkUnit-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WorkUnit</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;WorkUnit(<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;other)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../gobblin/source/workunit/WorkUnit.html#copyOf-gobblin.source.workunit.WorkUnit-"><code>copyOf(WorkUnit)</code></a></span></div>
<div class="block">Copy constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - the other <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEmpty</h4>
<pre>public static&nbsp;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;createEmpty()</pre>
<div class="block">Factory method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An empty <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</dd>
</dl>
</li>
</ul>
<a name="create-gobblin.source.workunit.Extract-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;create(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract)</pre>
<div class="block">Factory method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extract</code> - <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> with the given <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a></dd>
</dl>
</li>
</ul>
<a name="create-gobblin.source.workunit.Extract-gobblin.source.extractor.WatermarkInterval-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;create(<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;extract,
<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</pre>
<div class="block">Factory method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extract</code> - <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a></dd>
<dd><code>watermarkInterval</code> - <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> with the given <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a> and <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a></dd>
</dl>
</li>
</ul>
<a name="copyOf-gobblin.source.workunit.WorkUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyOf</h4>
<pre>public static&nbsp;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;copyOf(<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&nbsp;other)</pre>
<div class="block">Factory method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of the given <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="getExtract--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtract</h4>
<pre>public&nbsp;<a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit">Extract</a>&nbsp;getExtract()</pre>
<div class="block">Get the <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a> associated with this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../gobblin/source/workunit/Extract.html" title="class in gobblin.source.workunit"><code>Extract</code></a> associated with this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a></dd>
</dl>
</li>
</ul>
<a name="skip--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skip</h4>
<pre>public&nbsp;void&nbsp;skip()</pre>
<div class="block">This method will allow a work unit to be skipped if needed.</div>
</li>
</ul>
<a name="getLowWatermark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowWatermark</h4>
<pre>public&nbsp;com.google.gson.JsonElement&nbsp;getLowWatermark()</pre>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> as a <code>JsonElement</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>JsonElement</code> representing the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> or
<code>null</code> if the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> is not set.</dd>
</dl>
</li>
</ul>
<a name="getLowWatermark-java.lang.Class-com.google.gson.Gson-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowWatermark</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;&nbsp;T&nbsp;getLowWatermark(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass,
com.google.gson.Gson&nbsp;gson)</pre>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermarkClass</code> - the watermark class for this <code>WorkUnit</code>.</dd>
<dd><code>gson</code> - a <code>Gson</code> object used to deserialize the watermark.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the low watermark in this <code>WorkUnit</code>.</dd>
</dl>
</li>
</ul>
<a name="getLowWatermark-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowWatermark</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;&nbsp;T&nbsp;getLowWatermark(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass)</pre>
<div class="block">Get the low <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>. A default <code>Gson</code> object will be used to deserialize the watermark.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermarkClass</code> - the watermark class for this <code>WorkUnit</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the low watermark in this <code>WorkUnit</code>.</dd>
</dl>
</li>
</ul>
<a name="getExpectedHighWatermark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpectedHighWatermark</h4>
<pre>public&nbsp;com.google.gson.JsonElement&nbsp;getExpectedHighWatermark()</pre>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> as a <code>JsonElement</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>JsonElement</code> representing the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getExpectedHighWatermark-java.lang.Class-com.google.gson.Gson-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpectedHighWatermark</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;&nbsp;T&nbsp;getExpectedHighWatermark(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass,
com.google.gson.Gson&nbsp;gson)</pre>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermarkClass</code> - the watermark class for this <code>WorkUnit</code>.</dd>
<dd><code>gson</code> - a <code>Gson</code> object used to deserialize the watermark.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the expected high watermark in this <code>WorkUnit</code>.</dd>
</dl>
</li>
</ul>
<a name="getExpectedHighWatermark-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpectedHighWatermark</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&gt;&nbsp;T&nbsp;getExpectedHighWatermark(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;watermarkClass)</pre>
<div class="block">Get the expected high <a href="../../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a>. A default <code>Gson</code> object will be used to deserialize the watermark.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermarkClass</code> - the watermark class for this <code>WorkUnit</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the expected high watermark in this <code>WorkUnit</code>.</dd>
</dl>
</li>
</ul>
<a name="getHighWaterMark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHighWaterMark</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;long&nbsp;getHighWaterMark()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use the <a href="../../../gobblin/source/workunit/WorkUnit.html#getExpectedHighWatermark--"><code>getExpectedHighWatermark()</code></a> method.</span></div>
<div class="block">Get the high watermark of this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>high watermark</dd>
</dl>
</li>
</ul>
<a name="setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWatermarkInterval</h4>
<pre>public&nbsp;void&nbsp;setWatermarkInterval(<a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor">WatermarkInterval</a>&nbsp;watermarkInterval)</pre>
<div class="block">Set <a href="../../../gobblin/source/extractor/WatermarkInterval.html" title="class in gobblin.source.extractor"><code>WatermarkInterval</code></a> for a <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
</li>
</ul>
<a name="setHighWaterMark-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHighWaterMark</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;setHighWaterMark(long&nbsp;highWaterMark)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../gobblin/source/workunit/WorkUnit.html#setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-"><code>setWatermarkInterval(WatermarkInterval)</code></a>.</span></div>
<div class="block">Set the high watermark of this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>highWaterMark</code> - high watermark</dd>
</dl>
</li>
</ul>
<a name="getLowWaterMark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowWaterMark</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;long&nbsp;getLowWaterMark()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use the <a href="../../../gobblin/source/workunit/WorkUnit.html#getLowWatermark--"><code>getLowWatermark()</code></a> method.</span></div>
<div class="block">Get the low watermark of this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>low watermark</dd>
</dl>
</li>
</ul>
<a name="setLowWaterMark-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLowWaterMark</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;setLowWaterMark(long&nbsp;lowWaterMark)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../gobblin/source/workunit/WorkUnit.html#setWatermarkInterval-gobblin.source.extractor.WatermarkInterval-"><code>setWatermarkInterval(WatermarkInterval)</code></a>.</span></div>
<div class="block">Set the low watermark of this <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lowWaterMark</code> - low watermark</dd>
</dl>
</li>
</ul>
<a name="readFields-java.io.DataInput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFields</h4>
<pre>public&nbsp;void&nbsp;readFields(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;in)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../gobblin/compat/hadoop/WritableShim.html#readFields-java.io.DataInput-">readFields</a></code>&nbsp;in interface&nbsp;<code><a href="../../../gobblin/compat/hadoop/WritableShim.html" title="interface in gobblin.compat.hadoop">WritableShim</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../gobblin/configuration/State.html#readFields-java.io.DataInput-">readFields</a></code>&nbsp;in class&nbsp;<code><a href="../../../gobblin/configuration/State.html" title="class in gobblin.configuration">State</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="write-java.io.DataOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a>&nbsp;out)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../gobblin/compat/hadoop/WritableShim.html#write-java.io.DataOutput-">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../gobblin/compat/hadoop/WritableShim.html" title="interface in gobblin.compat.hadoop">WritableShim</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../gobblin/configuration/State.html#write-java.io.DataOutput-">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../gobblin/configuration/State.html" title="class in gobblin.configuration">State</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><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">
<li><a href="../../../gobblin/source/workunit/MultiWorkUnit.html" title="class in gobblin.source.workunit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/WorkUnit.html" target="_top">Frames</a></li>
<li><a href="WorkUnit.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>