blob: e4424d6481a31a3d2a92ebe4e9cc165e3a07557d [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:18 PDT 2017 -->
<title>ImmutableWorkUnitState (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="ImmutableWorkUnitState (gobblin-api 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All 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/configuration/ConfigurationKeys.html" title="class in gobblin.configuration"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/configuration/ImmutableWorkUnitState.html" target="_top">Frames</a></li>
<li><a href="ImmutableWorkUnitState.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><a href="#nested.classes.inherited.from.class.gobblin.configuration.WorkUnitState">Nested</a>&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.configuration</div>
<h2 title="Class ImmutableWorkUnitState" class="title">Class ImmutableWorkUnitState</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><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">gobblin.configuration.WorkUnitState</a></li>
<li>
<ul class="inheritance">
<li>gobblin.configuration.ImmutableWorkUnitState</li>
</ul>
</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ImmutableWorkUnitState</span>
extends <a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></pre>
<div class="block">An immutable version of <a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration"><code>WorkUnitState</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.gobblin.configuration.WorkUnitState">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;gobblin.configuration.<a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></h3>
<code><a href="../../gobblin/configuration/WorkUnitState.WorkingState.html" title="enum in gobblin.configuration">WorkUnitState.WorkingState</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/configuration/ImmutableWorkUnitState.html#ImmutableWorkUnitState-gobblin.configuration.WorkUnitState-">ImmutableWorkUnitState</a></span>(<a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a>&nbsp;workUnitState)</code>&nbsp;</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#addAll-java.util.Properties-">addAll</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</code>
<div class="block">Populates this instance with values of a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#addAllIfNotExist-java.util.Properties-">addAllIfNotExist</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</code>
<div class="block">Add properties in a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance that are not in the current instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#appendToListProp-java.lang.String-java.lang.String-">appendToListProp</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends the input value to a list property that can be retrieved with <a href="../../gobblin/configuration/State.html#getPropAsList-java.lang.String-"><code>State.getPropAsList(java.lang.String)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#backoffActualHighWatermark--">backoffActualHighWatermark</a></span>()</code>
<div class="block">Backoff the actual high watermark to the low watermark returned by <a href="../../gobblin/source/workunit/WorkUnit.html#getLowWatermark--"><code>WorkUnit.getLowWatermark()</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#overrideWith-java.util.Properties-">overrideWith</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</code>
<div class="block">Add properties in a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance that are in the current instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.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="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#setActualHighWatermark-gobblin.source.extractor.Watermark-">setActualHighWatermark</a></span>(<a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&nbsp;watermark)</code>
<div class="block">This method should set the actual, runtime high <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> for this <a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration"><code>WorkUnitState</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#setHighWaterMark-long-">setHighWaterMark</a></span>(long&nbsp;value)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#setId-java.lang.String-">setId</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">Set the id used for state persistence and logging.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#setProp-java.lang.String-java.lang.Object-">setProp</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</code>
<div class="block">Set a property.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/configuration/ImmutableWorkUnitState.html#setWorkingState-gobblin.configuration.WorkUnitState.WorkingState-">setWorkingState</a></span>(<a href="../../gobblin/configuration/WorkUnitState.WorkingState.html" title="enum in gobblin.configuration">WorkUnitState.WorkingState</a>&nbsp;state)</code>
<div class="block">Set the current runtime state of the <a href="../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.configuration.WorkUnitState">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.configuration.<a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></h3>
<code><a href="../../gobblin/configuration/WorkUnitState.html#addFinalConstructState-java.lang.String-gobblin.configuration.State-">addFinalConstructState</a>, <a href="../../gobblin/configuration/WorkUnitState.html#contains-java.lang.String-">contains</a>, <a href="../../gobblin/configuration/WorkUnitState.html#equals-java.lang.Object-">equals</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getActualHighWatermark--">getActualHighWatermark</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getActualHighWatermark-java.lang.Class-">getActualHighWatermark</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getActualHighWatermark-java.lang.Class-com.google.gson.Gson-">getActualHighWatermark</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getExtract--">getExtract</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getFinalConstructStates--">getFinalConstructStates</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getHighWaterMark--">getHighWaterMark</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getPreviousTableState--">getPreviousTableState</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getProp-java.lang.String-">getProp</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getProp-java.lang.String-java.lang.String-">getProp</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getProperties--">getProperties</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getProperty-java.lang.String-">getProperty</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getProperty-java.lang.String-java.lang.String-">getProperty</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getPropertyNames--">getPropertyNames</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getTaskBroker--">getTaskBroker</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getTaskBrokerNullable--">getTaskBrokerNullable</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getWorkingState--">getWorkingState</a>, <a href="../../gobblin/configuration/WorkUnitState.html#getWorkunit--">getWorkunit</a>, <a href="../../gobblin/configuration/WorkUnitState.html#hashCode--">hashCode</a>, <a href="../../gobblin/configuration/WorkUnitState.html#setJobState-gobblin.configuration.State-">setJobState</a>, <a href="../../gobblin/configuration/WorkUnitState.html#setWuProperties-java.util.Properties-java.util.Properties-">setWuProperties</a>, <a href="../../gobblin/configuration/WorkUnitState.html#toString--">toString</a>, <a href="../../gobblin/configuration/WorkUnitState.html#write-java.io.DataOutput-">write</a></code></li>
</ul>
<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-gobblin.configuration.State-">addAll</a>, <a href="../../gobblin/configuration/State.html#addAllIfNotExist-gobblin.configuration.State-">addAllIfNotExist</a>, <a href="../../gobblin/configuration/State.html#appendToSetProp-java.lang.String-java.lang.String-">appendToSetProp</a>, <a href="../../gobblin/configuration/State.html#getId--">getId</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#overrideWith-gobblin.configuration.State-">overrideWith</a>, <a href="../../gobblin/configuration/State.html#removeProp-java.lang.String-">removeProp</a>, <a href="../../gobblin/configuration/State.html#setProps-java.util.Properties-java.util.Properties-">setProps</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="ImmutableWorkUnitState-gobblin.configuration.WorkUnitState-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ImmutableWorkUnitState</h4>
<pre>public&nbsp;ImmutableWorkUnitState(<a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a>&nbsp;workUnitState)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setWorkingState-gobblin.configuration.WorkUnitState.WorkingState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWorkingState</h4>
<pre>public&nbsp;void&nbsp;setWorkingState(<a href="../../gobblin/configuration/WorkUnitState.WorkingState.html" title="enum in gobblin.configuration">WorkUnitState.WorkingState</a>&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html#setWorkingState-gobblin.configuration.WorkUnitState.WorkingState-">WorkUnitState</a></code></span></div>
<div class="block">Set the current runtime state of the <a href="../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/WorkUnitState.html#setWorkingState-gobblin.configuration.WorkUnitState.WorkingState-">setWorkingState</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - <a href="../../gobblin/configuration/WorkUnitState.WorkingState.html" title="enum in gobblin.configuration"><code>WorkUnitState.WorkingState</code></a> of the <a href="../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a></dd>
</dl>
</li>
</ul>
<a name="setActualHighWatermark-gobblin.source.extractor.Watermark-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActualHighWatermark</h4>
<pre>public&nbsp;void&nbsp;setActualHighWatermark(<a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor">Watermark</a>&nbsp;watermark)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html#setActualHighWatermark-gobblin.source.extractor.Watermark-">WorkUnitState</a></code></span></div>
<div class="block">This method should set the actual, runtime high <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> for this <a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration"><code>WorkUnitState</code></a>. A high
<a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> indicates that all data for the source has been pulled up to a specific point.
<p>
This method should be called inside the <a href="../../gobblin/source/extractor/Extractor.html" title="interface in gobblin.source.extractor"><code>Extractor</code></a> class, during the initialization
of the class, before any calls to <a href="../../gobblin/source/extractor/Extractor.html#readRecord-D-"><code>Extractor.readRecord(Object)</code></a> are executed. This
method keeps a local point to the given <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> and expects the following invariant to always be upheld.
The invariant for this <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> is that it should cover all records up to and including the most recent
record returned by <a href="../../gobblin/source/extractor/Extractor.html#readRecord-D-"><code>Extractor.readRecord(Object)</code></a>.
</p>
<p>
The <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> set in this method may be polled by the framework multiple times, in order to track the
progress of how the <a href="../../gobblin/source/extractor/Watermark.html" title="interface in gobblin.source.extractor"><code>Watermark</code></a> changes. This is important for reporting percent completion of a
<a href="../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>.
</p>
TODO - Once we are ready to make a backwards incompatible change to the <a href="../../gobblin/source/extractor/Extractor.html" title="interface in gobblin.source.extractor"><code>Extractor</code></a>
interface, this method should become part of the <a href="../../gobblin/source/extractor/Extractor.html" title="interface in gobblin.source.extractor"><code>Extractor</code></a> interface. For example,
a method such as getCurrentHighWatermark() should be added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/WorkUnitState.html#setActualHighWatermark-gobblin.source.extractor.Watermark-">setActualHighWatermark</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></code></dd>
</dl>
</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;value)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html#setHighWaterMark-long-">WorkUnitState</a></code></span></div>
<div class="block">Set the high watermark.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/WorkUnitState.html#setHighWaterMark-long-">setHighWaterMark</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - high watermark</dd>
</dl>
</li>
</ul>
<a name="setProp-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProp</h4>
<pre>public&nbsp;void&nbsp;setProp(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#setProp-java.lang.String-java.lang.Object-">State</a></code></span></div>
<div class="block">Set a property.
<p>
Both key and value are stored as strings.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#setProp-java.lang.String-java.lang.Object-">setProp</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="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - property key</dd>
<dd><code>value</code> - property value</dd>
</dl>
</li>
</ul>
<a name="addAll-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre>public&nbsp;void&nbsp;addAll(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#addAll-java.util.Properties-">State</a></code></span></div>
<div class="block">Populates this instance with values of a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#addAll-java.util.Properties-">addAll</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="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="addAllIfNotExist-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAllIfNotExist</h4>
<pre>public&nbsp;void&nbsp;addAllIfNotExist(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#addAllIfNotExist-java.util.Properties-">State</a></code></span></div>
<div class="block">Add properties in a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance that are not in the current instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#addAllIfNotExist-java.util.Properties-">addAllIfNotExist</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="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="overrideWith-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>overrideWith</h4>
<pre>public&nbsp;void&nbsp;overrideWith(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#overrideWith-java.util.Properties-">State</a></code></span></div>
<div class="block">Add properties in a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance that are in the current instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#overrideWith-java.util.Properties-">overrideWith</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="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> instance</dd>
</dl>
</li>
</ul>
<a name="setId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#setId-java.lang.String-">State</a></code></span></div>
<div class="block">Set the id used for state persistence and logging.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#setId-java.lang.String-">setId</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="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - id of this instance</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/WorkUnitState.html#readFields-java.io.DataInput-">readFields</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</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="backoffActualHighWatermark--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backoffActualHighWatermark</h4>
<pre>public&nbsp;void&nbsp;backoffActualHighWatermark()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html#backoffActualHighWatermark--">WorkUnitState</a></code></span></div>
<div class="block">Backoff the actual high watermark to the low watermark returned by <a href="../../gobblin/source/workunit/WorkUnit.html#getLowWatermark--"><code>WorkUnit.getLowWatermark()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/WorkUnitState.html#backoffActualHighWatermark--">backoffActualHighWatermark</a></code>&nbsp;in class&nbsp;<code><a href="../../gobblin/configuration/WorkUnitState.html" title="class in gobblin.configuration">WorkUnitState</a></code></dd>
</dl>
</li>
</ul>
<a name="appendToListProp-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>appendToListProp</h4>
<pre>public&nbsp;void&nbsp;appendToListProp(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../gobblin/configuration/State.html#appendToListProp-java.lang.String-java.lang.String-">State</a></code></span></div>
<div class="block">Appends the input value to a list property that can be retrieved with <a href="../../gobblin/configuration/State.html#getPropAsList-java.lang.String-"><code>State.getPropAsList(java.lang.String)</code></a>.
<p>
List properties are internally stored as comma separated strings. Adding a value that contains commas (for
example "a,b,c") will essentially add multiple values to the property ("a", "b", and "c"). This is
similar to the way that <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf"><code>Configuration</code></a> works.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../gobblin/configuration/State.html#appendToListProp-java.lang.String-java.lang.String-">appendToListProp</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="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - property key</dd>
<dd><code>value</code> - property value (if it includes commas, it will be split by the commas).</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/configuration/ConfigurationKeys.html" title="class in gobblin.configuration"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/configuration/SourceState.html" title="class in gobblin.configuration"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/configuration/ImmutableWorkUnitState.html" target="_top">Frames</a></li>
<li><a href="ImmutableWorkUnitState.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><a href="#nested.classes.inherited.from.class.gobblin.configuration.WorkUnitState">Nested</a>&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>