http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/CreateStream.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/CreateStream.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/CreateStream.html new file mode 100644 index 0000000..0e0a6f7 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/CreateStream.html @@ -0,0 +1,512 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>CreateStream</title> +<meta name="date" content="2017-03-08"> +<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="CreateStream"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../../org/apache/beam/runners/spark/io/ConsoleIO.Write.Unbound.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/CreateStream.html" target="_top">Frames</a></li> +<li><a href="CreateStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.spark.io</div> +<h2 title="Class CreateStream" class="title">Class CreateStream<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.CreateStream<T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - stream type.</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">CreateStream<T></span> +extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>></pre> +<div class="block">Create an input stream from Queue. For SparkRunner tests only. + + <p>To properly compose a stream of micro-batches with their Watermarks, please keep in mind + that eventually there a two queues here - one for batches and another for Watermarks. + + <p>While both queues advance according to Spark's batch-interval, there is a slight difference + in how data is pushed into the stream compared to the advancement of Watermarks since Watermarks + advance onBatchCompleted hook call so if you'd want to set the watermark advance for a specific + batch it should be called before that batch. + Also keep in mind that being a queue that is polled per batch interval, if there is a need to + "hold" the same Watermark without advancing it it should be stated explicitly or the Watermark + will advance as soon as it can (in the next batch completed hook). + + <p>Example 1: + + <code>CreateStream.<TimestampedValue<String>>withBatchInterval(batchDuration) + .nextBatch( + TimestampedValue.of("foo", endOfGlobalWindow), + TimestampedValue.of("bar", endOfGlobalWindow)) + .advanceNextBatchWatermarkToInfinity(); + </code> + The first batch will see the default start-of-time WM of + <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a> and any following batch will see + the end-of-time WM <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MAX_VALUE"><code>BoundedWindow.TIMESTAMP_MAX_VALUE</code></a>. + + <p>Example 2: + + <code>CreateStream.<TimestampedValue<String>>withBatchInterval(batchDuration) + .nextBatch( + TimestampedValue.of(1, instant)) + .advanceWatermarkForNextBatch(instant.plus(Duration.standardMinutes(20))) + .nextBatch( + TimestampedValue.of(2, instant)) + .nextBatch( + TimestampedValue.of(3, instant)) + .advanceWatermarkForNextBatch(instant.plus(Duration.standardMinutes(30))) + </code> + The first batch will see the start-of-time WM and the second will see the advanced (+20 min.) WM. + The third WM will see the WM advanced to +30 min, because this is the next advancement of the WM + regardless of where it ws called in the construction of CreateStream. + //TODO: write a proper Builder enforcing all those rules mentioned.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.spark.io.CreateStream">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a></code></li> +</ul> +</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#advanceNextBatchWatermarkToInfinity--">advanceNextBatchWatermarkToInfinity</a></span>()</code> +<div class="block">Advances the watermark in the next batch to the end-of-time.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#advanceWatermarkForNextBatch-org.joda.time.Instant-">advanceWatermarkForNextBatch</a></span>(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> newWatermark)</code> +<div class="block">Advances the watermark in the next batch.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#emptyBatch--">emptyBatch</a></span>()</code> +<div class="block">Adds an empty batch.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#expand-org.apache.beam.sdk.values.PBegin-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</code> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.util.Queue<java.lang.Iterable<<a href="../../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#getBatches--">getBatches</a></span>()</code> +<div class="block">Get the underlying queue representing the mock stream of micro-batches.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#getDefaultOutputCoder--">getDefaultOutputCoder</a></span>()</code> +<div class="block">Returns the default <code>Coder</code> to use for the output of this + single-output <code>PTransform</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.util.Queue<<a href="../../../../../../org/apache/beam/runners/spark/util/GlobalWatermarkHolder.SparkWatermarks.html" title="class in org.apache.beam.runners.spark.util">GlobalWatermarkHolder.SparkWatermarks</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#getTimes--">getTimes</a></span>()</code> +<div class="block">Get times so they can be pushed into the + <a href="../../../../../../org/apache/beam/runners/spark/util/GlobalWatermarkHolder.html" title="class in org.apache.beam.runners.spark.util"><code>GlobalWatermarkHolder</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#initialSystemTimeAt-org.joda.time.Instant-">initialSystemTimeAt</a></span>(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> initialSystemTime)</code> +<div class="block">Set the initial synchronized processing time.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#nextBatch-T...-">nextBatch</a></span>(<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>... batchElements)</code> +<div class="block">For non-timestamped elements.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#nextBatch-org.apache.beam.sdk.values.TimestampedValue...-">nextBatch</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>... batchElements)</code> +<div class="block">Enqueue next micro-batch elements.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html#of-org.apache.beam.sdk.coders.Coder-org.joda.time.Duration-">of</a></span>(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> coder, + <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Duration.html?is-external=true"; title="class or interface in org.joda.time">Duration</a> batchInterval)</code> +<div class="block">Set the batch interval for the stream.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">validate</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of-org.apache.beam.sdk.coders.Coder-org.joda.time.Duration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <T> <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><T> of(<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> coder, + <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Duration.html?is-external=true"; title="class or interface in org.joda.time">Duration</a> batchInterval)</pre> +<div class="block">Set the batch interval for the stream.</div> +</li> +</ul> +<a name="nextBatch-org.apache.beam.sdk.values.TimestampedValue...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextBatch</h4> +<pre>@SafeVarargs +public final <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> nextBatch(<a href="../../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>... batchElements)</pre> +<div class="block">Enqueue next micro-batch elements. + This is backed by a <code>Queue</code> so stream input order would keep the population order (FIFO).</div> +</li> +</ul> +<a name="nextBatch-java.lang.Object:A-"> +<!-- --> +</a><a name="nextBatch-T...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextBatch</h4> +<pre>@SafeVarargs +public final <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> nextBatch(<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>... batchElements)</pre> +<div class="block">For non-timestamped elements.</div> +</li> +</ul> +<a name="emptyBatch--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyBatch</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> emptyBatch()</pre> +<div class="block">Adds an empty batch.</div> +</li> +</ul> +<a name="initialSystemTimeAt-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialSystemTimeAt</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> initialSystemTimeAt(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> initialSystemTime)</pre> +<div class="block">Set the initial synchronized processing time.</div> +</li> +</ul> +<a name="advanceWatermarkForNextBatch-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceWatermarkForNextBatch</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> advanceWatermarkForNextBatch(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> newWatermark)</pre> +<div class="block">Advances the watermark in the next batch.</div> +</li> +</ul> +<a name="advanceNextBatchWatermarkToInfinity--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceNextBatchWatermarkToInfinity</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io">CreateStream</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> advanceNextBatchWatermarkToInfinity()</pre> +<div class="block">Advances the watermark in the next batch to the end-of-time.</div> +</li> +</ul> +<a name="getBatches--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatches</h4> +<pre>public java.util.Queue<java.lang.Iterable<<a href="../../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>>> getBatches()</pre> +<div class="block">Get the underlying queue representing the mock stream of micro-batches.</div> +</li> +</ul> +<a name="getTimes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimes</h4> +<pre>public java.util.Queue<<a href="../../../../../../org/apache/beam/runners/spark/util/GlobalWatermarkHolder.SparkWatermarks.html" title="class in org.apache.beam.runners.spark.util">GlobalWatermarkHolder.SparkWatermarks</a>> getTimes()</pre> +<div class="block">Get times so they can be pushed into the + <a href="../../../../../../org/apache/beam/runners/spark/util/GlobalWatermarkHolder.html" title="class in org.apache.beam.runners.spark.util"><code>GlobalWatermarkHolder</code></a>.</div> +</li> +</ul> +<a name="expand-org.apache.beam.sdk.values.PBegin-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>expand</h4> +<pre>public <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> expand(<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>. + + <p>Composite transforms, which are defined in terms of other transforms, + should return the output of one of the composed transforms. Non-composite + transforms, which do not apply any transforms internally, should return + a new unbound output and register evaluators (via backend-specific + registration methods).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>></code></dd> +</dl> +</li> +</ul> +<a name="getDefaultOutputCoder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDefaultOutputCoder</h4> +<pre>protected <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>> getDefaultOutputCoder() + throws <a href="../../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">PTransform</a></code></span></div> +<div class="block">Returns the default <code>Coder</code> to use for the output of this + single-output <code>PTransform</code>. + + <p>By default, always throws</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="type parameter in CreateStream">T</a>>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></code> - if no coder can be inferred</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="../../../../../../org/apache/beam/runners/spark/io/ConsoleIO.Write.Unbound.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/CreateStream.html" target="_top">Frames</a></li> +<li><a href="CreateStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/EmptyCheckpointMark.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/EmptyCheckpointMark.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/EmptyCheckpointMark.html new file mode 100644 index 0000000..6da0b72 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/EmptyCheckpointMark.html @@ -0,0 +1,327 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>EmptyCheckpointMark</title> +<meta name="date" content="2017-03-08"> +<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="EmptyCheckpointMark"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" target="_top">Frames</a></li> +<li><a href="EmptyCheckpointMark.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.spark.io</div> +<h2 title="Class EmptyCheckpointMark" class="title">Class EmptyCheckpointMark</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.EmptyCheckpointMark</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">EmptyCheckpointMark</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>, java.io.Serializable</pre> +<div class="block">Passing null values to Spark's Java API may cause problems because of Guava preconditions. + See: <code>JavaUtils.optionToOptional(scala.Option<T>)</code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.spark.io.EmptyCheckpointMark">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html#finalizeCheckpoint--">finalizeCheckpoint</a></span>()</code> +<div class="block">Called by the system to signal that this checkpoint mark has been committed along with + all the records which have been read from the <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> since the + previous checkpoint was taken.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" title="class in org.apache.beam.runners.spark.io">EmptyCheckpointMark</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html#get--">get</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" title="class in org.apache.beam.runners.spark.io">EmptyCheckpointMark</a> get()</pre> +</li> +</ul> +<a name="finalizeCheckpoint--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finalizeCheckpoint</h4> +<pre>public void finalizeCheckpoint() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html#finalizeCheckpoint--">UnboundedSource.CheckpointMark</a></code></span></div> +<div class="block">Called by the system to signal that this checkpoint mark has been committed along with + all the records which have been read from the <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> since the + previous checkpoint was taken. + + <p>For example, this method could send acknowledgements to an external data source + such as Pubsub. + + <p>Note that: + <ul> + <li>This finalize method may be called from any thread, concurrently with calls to + the <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> it was created from. + <li>Checkpoints will not necessarily be finalized as soon as they are created. + A checkpoint may be taken while a previous checkpoint from the same + <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> has not yet be finalized. + <li>In the absence of failures, all checkpoints will be finalized and they will be + finalized in the same order they were taken from the <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a>. + <li>It is possible for a checkpoint to be taken but this method never called. This method + will never be called if the checkpoint could not be committed, and other failures may cause + this method to never be called. + <li>It is not safe to assume the <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> from which this checkpoint was + created still exists at the time this method is called. + </ul></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html#finalizeCheckpoint--">finalizeCheckpoint</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</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="../../../../../../org/apache/beam/runners/spark/io/CreateStream.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/EmptyCheckpointMark.html" target="_top">Frames</a></li> +<li><a href="EmptyCheckpointMark.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html new file mode 100644 index 0000000..89653e2 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html @@ -0,0 +1,529 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>MicrobatchSource.Reader</title> +<meta name="date" content="2017-03-08"> +<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="MicrobatchSource.Reader"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html" target="_top">Frames</a></li> +<li><a href="MicrobatchSource.Reader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.io.BoundedSource.BoundedReader">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.spark.io</div> +<h2 title="Class MicrobatchSource.Reader" class="title">Class MicrobatchSource.Reader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.Source.Reader</a><T></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.BoundedSource.BoundedReader</a><T></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.MicrobatchSource.Reader</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.AutoCloseable</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io">MicrobatchSource</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>,<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a> extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MicrobatchSource.Reader</span> +extends <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a><T></pre> +<div class="block">A <code>BoundedSource.BoundedReader</code> + wrapping an <code>UnboundedSource.UnboundedReader</code>. + + <p>This Reader will read until it reached the bound of duration, or max records, + whichever comes first.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.io.BoundedSource.BoundedReader"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.io.<a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a></h3> +<code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#SPLIT_POINTS_UNKNOWN">SPLIT_POINTS_UNKNOWN</a></code></li> +</ul> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#advance--">advance</a></span>()</code> +<div class="block">Advances the reader to the next valid record.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#close--">close</a></span>()</code> +<div class="block">Closes the reader.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#getCheckpointMark--">getCheckpointMark</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#getCurrent--">getCurrent</a></span>()</code> +<div class="block">Returns the value of the data item that was read by the last <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or + <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> call.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#getCurrentSource--">getCurrentSource</a></span>()</code> +<div class="block">Returns a <code>Source</code> describing the same input that this <code>Reader</code> currently reads + (including items already read).</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#getCurrentTimestamp--">getCurrentTimestamp</a></span>()</code> +<div class="block">By default, returns the minimum possible timestamp.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#getWatermark--">getWatermark</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html#start--">start</a></span>()</code> +<div class="block">Initializes the reader and advances the reader to the first record.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.BoundedSource.BoundedReader"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.io.<a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a></h3> +<code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getFractionConsumed--">getFractionConsumed</a>, <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getSplitPointsConsumed--">getSplitPointsConsumed</a>, <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getSplitPointsRemaining--">getSplitPointsRemaining</a>, <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#splitAtFraction-double-">splitAtFraction</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="start--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public boolean start() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--">Source.Reader</a></code></span></div> +<div class="block">Initializes the reader and advances the reader to the first record. + + <p>This method should be called exactly once. The invocation should occur prior to calling + <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#getCurrent--"><code>Source.Reader.getCurrent()</code></a>. This method may perform expensive operations that + are needed to initialize the reader.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--">start</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if a record was read, <code>false</code> if there is no more input available.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="advance--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advance</h4> +<pre>public boolean advance() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--">Source.Reader</a></code></span></div> +<div class="block">Advances the reader to the next valid record. + + <p>It is an error to call this without having called <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> first.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--">advance</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if a record was read, <code>false</code> if there is no more input available.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getCurrent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrent</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a> getCurrent() + throws java.util.NoSuchElementException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#getCurrent--">Source.Reader</a></code></span></div> +<div class="block">Returns the value of the data item that was read by the last <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or + <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> call. The returned value must be effectively immutable and remain valid + indefinitely. + + <p>Multiple calls to this method without an intervening call to <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> should + return the same result.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#getCurrent--">getCurrent</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.util.NoSuchElementException</code> - if <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> was never called, or if + the last <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> returned <code>false</code>.</dd> +</dl> +</li> +</ul> +<a name="getCurrentTimestamp--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentTimestamp</h4> +<pre>public <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> getCurrentTimestamp() + throws java.util.NoSuchElementException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentTimestamp--">BoundedSource.BoundedReader</a></code></span></div> +<div class="block">By default, returns the minimum possible timestamp.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentTimestamp--">getCurrentTimestamp</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.util.NoSuchElementException</code> - if the reader is at the beginning of the input and + <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> wasn't called, or if the last <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#start--"><code>Source.Reader.start()</code></a> or + <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#advance--"><code>Source.Reader.advance()</code></a> returned <code>false</code>.</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#close--">Source.Reader</a></code></span></div> +<div class="block">Closes the reader. The reader cannot be used after this method is called.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#close--">close</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getCurrentSource--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentSource</h4> +<pre>public <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>> getCurrentSource()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentSource--">BoundedSource.BoundedReader</a></code></span></div> +<div class="block">Returns a <code>Source</code> describing the same input that this <code>Reader</code> currently reads + (including items already read). + + <h3>Usage</h3> + + <p>Reader subclasses can use this method for convenience to access unchanging properties of + the source being read. Alternatively, they can cache these properties in the constructor. + + <p>The framework will call this method in the course of dynamic work rebalancing, e.g. after + a successful <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#splitAtFraction-double-"><code>BoundedSource.BoundedReader.splitAtFraction(double)</code></a> call. + + <h3>Mutability and thread safety</h3> + + <p>Remember that <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> objects must always be immutable. However, the return value + of this function may be affected by dynamic work rebalancing, happening asynchronously via + <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#splitAtFraction-double-"><code>BoundedSource.BoundedReader.splitAtFraction(double)</code></a>, meaning it can return a different + <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> object. However, the returned object itself will still itself be immutable. + Callers must take care not to rely on properties of the returned source that may be + asynchronously changed as a result of this process (e.g. do not cache an end offset when + reading a file). + + <h3>Implementation</h3> + + <p>For convenience, subclasses should usually return the most concrete subclass of + <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> possible. + In practice, the implementation of this method should nearly always be one of the following: + <ul> + <li>Source that inherits from a base class that already implements + <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentSource--"><code>BoundedSource.BoundedReader.getCurrentSource()</code></a>: delegate to base class. In this case, it is almost always + an error for the subclass to maintain its own copy of the source. + <pre><code> + public FooReader(FooSource<T> source) { + super(source); + } + + public FooSource<T> getCurrentSource() { + return (FooSource<T>)super.getCurrentSource(); + } + </code></pre> + <li>Source that does not support dynamic work rebalancing: return a private final variable. + <pre><code> + private final FooSource<T> source; + + public FooReader(FooSource<T> source) { + this.source = source; + } + + public FooSource<T> getCurrentSource() { + return source; + } + </code></pre> + <li><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource.BoundedReader</code></a> that explicitly supports dynamic work rebalancing: + maintain a variable pointing to an immutable source object, and protect it with + synchronization. + <pre><code> + private FooSource<T> source; + + public FooReader(FooSource<T> source) { + this.source = source; + } + + public synchronized FooSource<T> getCurrentSource() { + return source; + } + + public synchronized FooSource<T> splitAtFraction(double fraction) { + ... + FooSource<T> primary = ...; + FooSource<T> residual = ...; + this.source = primary; + return residual; + } + </code></pre> + </ul></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentSource--">getCurrentSource</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getCheckpointMark--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointMark</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a> getCheckpointMark()</pre> +</li> +</ul> +<a name="getWatermark--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getWatermark</h4> +<pre>public <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true"; title="class or interface in org.joda.time">Instant</a> getWatermark()</pre> +</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="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.html" title="class in org.apache.beam.runners.spark.io"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html" target="_top">Frames</a></li> +<li><a href="MicrobatchSource.Reader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.io.BoundedSource.BoundedReader">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
