http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html new file mode 100644 index 0000000..6c9ac0c --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html @@ -0,0 +1,447 @@ +<!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 Fri May 12 16:50:05 PDT 2017 --> +<title>MicrobatchSource.Reader</title> +<meta name="date" content="2017-05-12"> +<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>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 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>org.apache.beam.runners.spark.io.MicrobatchSource.Reader</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/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><T></pre> +<div class="block">Mostly based on + <a href="../../../../../../org/apache/beam/sdk/io/BoundedReadFromUnboundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedReadFromUnboundedSource</code></a>'s + <code>UnboundedToBoundedSourceAdapter</code>, + with some adjustments for Spark specifics. + + <p>This Reader reads until one of the following thresholds has been reached: + <ol> + <li>max records (per batch)</li> + <li>max read duration (per batch)</li> + </ol></div> +</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="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/Source.html" title="class in org.apache.beam.sdk.io">Source</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">Returns the timestamp associated with the current data item.</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.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/Source.Reader.html#getCurrentTimestamp--">Source.Reader</a></code></span></div> +<div class="block">Returns the timestamp associated with the current data item. + + <p>If the source does not support timestamps, this should return + <code>BoundedWindow.TIMESTAMP_MIN_VALUE</code>. + + <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#getCurrentTimestamp--">getCurrentTimestamp</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 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/Source.html" title="class in org.apache.beam.sdk.io">Source</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/Source.Reader.html#getCurrentSource--">Source.Reader</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). + + <p>Usually, an implementation will simply return the immutable <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> object from + which the current <a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io"><code>Source.Reader</code></a> was constructed, or delegate to the base class. + However, when using or implementing this method on a <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource.BoundedReader</code></a>, + special considerations apply, see documentation for + <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html#getCurrentSource--"><code>BoundedSource.BoundedReader.getCurrentSource()</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.Reader.html#getCurrentSource--">getCurrentSource</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> +</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>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/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.html new file mode 100644 index 0000000..d27eb24 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/MicrobatchSource.html @@ -0,0 +1,408 @@ +<!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 Fri May 12 16:50:05 PDT 2017 --> +<title>MicrobatchSource</title> +<meta name="date" content="2017-05-12"> +<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"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/EmptyCheckpointMark.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.Reader.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.html" target="_top">Frames</a></li> +<li><a href="MicrobatchSource.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><a href="#nested.class.summary">Nested</a> | </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 MicrobatchSource" class="title">Class MicrobatchSource<T,CheckpointMarkT extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></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.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.Source</a><T></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.MicrobatchSource<T,CheckpointMarkT></li> +</ul> +</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/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MicrobatchSource<T,CheckpointMarkT extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></span> +extends <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><T></pre> +<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> that accommodates Spark's micro-batch oriented nature and wraps an + <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.spark.io.MicrobatchSource">Serialized Form</a></dd> +</dl> +</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.Reader.html" title="class in org.apache.beam.runners.spark.io">MicrobatchSource.Reader</a></span></code> +<div class="block">Mostly based on + <a href="../../../../../../org/apache/beam/sdk/io/BoundedReadFromUnboundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedReadFromUnboundedSource</code></a>'s + <code>UnboundedToBoundedSourceAdapter</code>, + with some adjustments for Spark specifics.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html#clearCache--">clearCache</a></span>()</code> </td> +</tr> +<tr id="i1" 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.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<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.html#getCheckpointMarkCoder--">getCheckpointMarkCoder</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</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.html#getDefaultOutputCoder--">getDefaultOutputCoder</a></span>()</code> +<div class="block">Returns the default <code>Coder</code> to use for the data read from this source.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html#getId--">getId</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><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></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html#getOrCreateReader-org.apache.beam.sdk.options.PipelineOptions-CheckpointMarkT-">getOrCreateReader</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options, + <a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a> checkpointMark)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i7" 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.html#validate--">validate</a></span>()</code> +<div class="block">Checks that this source is valid, before it can be used in a pipeline.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.Source"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.io.<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a></h3> +<code><a href="../../../../../../org/apache/beam/sdk/io/Source.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</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, 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="getOrCreateReader-org.apache.beam.sdk.options.PipelineOptions-org.apache.beam.sdk.io.UnboundedSource.CheckpointMark-"> +<!-- --> +</a><a name="getOrCreateReader-org.apache.beam.sdk.options.PipelineOptions-CheckpointMarkT-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrCreateReader</h4> +<pre>public <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>> getOrCreateReader(<a href="../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options, + <a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a> checkpointMark) + throws java.io.IOException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="validate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public void validate()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.html#validate--">Source</a></code></span></div> +<div class="block">Checks that this source is valid, before it can be used in a pipeline. + + <p>It is recommended to use <a href="http://google.github.io/guava/releases/20.0/api/docs/com/google/common/base/Preconditions.html?is-external=true"; title="class or interface in com.google.common.base"><code>Preconditions</code></a> for implementing + this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.html#validate--">validate</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</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="getDefaultOutputCoder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultOutputCoder</h4> +<pre>public <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">T</a>> getDefaultOutputCoder()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/io/Source.html#getDefaultOutputCoder--">Source</a></code></span></div> +<div class="block">Returns the default <code>Coder</code> to use for the data read from this source.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/sdk/io/Source.html#getDefaultOutputCoder--">getDefaultOutputCoder</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</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="getCheckpointMarkCoder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointMarkCoder</h4> +<pre>public <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="type parameter in MicrobatchSource">CheckpointMarkT</a>> getCheckpointMarkCoder()</pre> +</li> +</ul> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public java.lang.String getId()</pre> +</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 o)</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="blockList"> +<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> +<a name="clearCache--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>clearCache</h4> +<pre>public static void clearCache()</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/EmptyCheckpointMark.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.Reader.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.html" target="_top">Frames</a></li> +<li><a href="MicrobatchSource.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><a href="#nested.class.summary">Nested</a> | </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/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Bounded.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Bounded.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Bounded.html new file mode 100644 index 0000000..cada21f --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Bounded.html @@ -0,0 +1,340 @@ +<!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 Fri May 12 16:50:05 PDT 2017 --> +<title>SourceRDD.Bounded</title> +<meta name="date" content="2017-05-12"> +<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="SourceRDD.Bounded"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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/SourceRDD.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.Unbounded.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/SourceRDD.Bounded.html" target="_top">Frames</a></li> +<li><a href="SourceRDD.Bounded.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><a href="#nested.classes.inherited.from.class.org.apache.spark.rdd.RDD">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.spark.rdd.RDD">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 SourceRDD.Bounded" class="title">Class SourceRDD.Bounded<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.rdd.RDD<org.apache.beam.sdk.util.WindowedValue<T>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.SourceRDD.Bounded<T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, org.apache.spark.Logging</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.html" title="class in org.apache.beam.runners.spark.io">SourceRDD</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">SourceRDD.Bounded<T></span> +extends org.apache.spark.rdd.RDD<org.apache.beam.sdk.util.WindowedValue<T>></pre> +<div class="block">A <a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html" title="class in org.apache.beam.runners.spark.io"><code>SourceRDD.Bounded</code></a> reads input from a <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource</code></a> + and creates a Spark <code>RDD</code>. + This is the default way for the SparkRunner to read data from Beam's BoundedSources.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.spark.io.SourceRDD.Bounded">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.spark.rdd.RDD"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.spark.rdd.RDD</h3> +<code>org$apache$spark$rdd$RDD$$evidence$1</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"> </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="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html#Bounded-org.apache.spark.SparkContext-org.apache.beam.sdk.io.BoundedSource-org.apache.beam.runners.spark.translation.SparkRuntimeContext-java.lang.String-">Bounded</a></span>(org.apache.spark.SparkContext sc, + <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/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>> source, + org.apache.beam.runners.spark.translation.SparkRuntimeContext runtimeContext, + java.lang.String stepName)</code> </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"> </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>scala.collection.Iterator<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html#compute-org.apache.spark.Partition-org.apache.spark.TaskContext-">compute</a></span>(org.apache.spark.Partition split, + org.apache.spark.TaskContext context)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.spark.Partition[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html#getPartitions--">getPartitions</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.rdd.RDD"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.spark.rdd.RDD</h3> +<code>$plus$plus, aggregate, cache, cartesian, checkpoint, checkpointData_$eq, checkpointData, clearDependencies, coalesce, coalesce$default$2, coalesce$default$3, collect, collect, collectPartitions, computeOrReadCheckpoint, conf, context, count, countApprox, countApprox$default$2, countApproxDistinct, countApproxDistinct, countApproxDistinct$default$1, countByValue, countByValue$default$1, countByValueApprox, countByValueApprox$default$2, countByValueApprox$default$3, creationSite, dependencies, distinct, distinct, distinct$default$2, doCheckpoint, doubleRDDToDoubleRDDFunctions, elementClassTag, filter, filterWith, first, firstParent, flatMap, flatMapWith, flatMapWith$default$2, fold, foreach, foreachPartition, foreachWith, getCheckpointFile, getCreationSite, getDependencies, getNarrowAncestors, getNumPartitions, getPreferredLocations, getStorageLevel, glom, groupBy, groupBy, groupBy, groupBy$default$4, id, intersection, intersection, intersection, intersection$default$3, isCheckp ointed, isCheckpointedAndMaterialized, isEmpty, isLocallyCheckpointed, isTraceEnabled, iterator, keyBy, localCheckpoint, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, map, mapPartitions, mapPartitions$default$2, mapPartitionsInternal, mapPartitionsInternal$default$2, mapPartitionsWithContext, mapPartitionsWithContext$default$2, mapPartitionsWithIndex, mapPartitionsWithIndex$default$2, mapPartitionsWithSplit, mapPartitionsWithSplit$default$2, mapWith, mapWith$default$2, markCheckpointed, max, min, name_$eq, name, numericRDDToDoubleRDDFunctions, org$apache$spark$Logging$$log__$eq, org$apache$spark$Logging$$log_, org$apache$spark$rdd$RDD$$debugString$1, org$apache$spark$rdd$RDD$$debugString$default$4$1, org$apache$spark$rdd$RDD$$dependencies__$eq, org$apache$spark$rdd$RDD$$dependencies_, org$apache$spark$rdd$RDD$$doCheckpointCalled_$eq, org$apache$spark$rdd$RDD$$doCheckpointCalled, org$apache$spark$rdd$RDD$$partition s__$eq, org$apache$spark$rdd$RDD$$partitions_, org$apache$spark$rdd$RDD$$sc, org$apache$spark$rdd$RDD$$visit$1, parent, partitioner, partitions, persist, persist, pipe, pipe, pipe, pipe$default$2, pipe$default$3, pipe$default$4, pipe$default$5, preferredLocations, randomSampleWithRange, randomSplit, randomSplit$default$2, rddToAsyncRDDActions, rddToOrderedRDDFunctions, rddToPairRDDFunctions, rddToPairRDDFunctions$default$4, rddToSequenceFileRDDFunctions, reduce, repartition, repartition$default$2, retag, retag, sample, sample$default$3, saveAsObjectFile, saveAsTextFile, saveAsTextFile, scope, setName, sortBy, sortBy$default$2, sortBy$default$3, sparkContext, subtract, subtract, subtract, subtract$default$3, take, takeOrdered, takeSample, takeSample$default$3, toArray, toDebugString, toJavaRDD, toLocalIterator, top, toString, treeAggregate, treeAggregate$default$4, treeReduce, treeReduce$default$2, union, unpersist, unpersist$default$1, withScope, zip, zipPartitions, zipPartitions, z ipPartitions, zipPartitions, zipPartitions, zipPartitions, zipWithIndex, zipWithUniqueId</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Bounded-org.apache.spark.SparkContext-org.apache.beam.sdk.io.BoundedSource-org.apache.beam.runners.spark.translation.SparkRuntimeContext-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Bounded</h4> +<pre>public Bounded(org.apache.spark.SparkContext sc, + <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/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>> source, + org.apache.beam.runners.spark.translation.SparkRuntimeContext runtimeContext, + java.lang.String stepName)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPartitions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitions</h4> +<pre>public org.apache.spark.Partition[] getPartitions()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getPartitions</code> in class <code>org.apache.spark.rdd.RDD<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>>></code></dd> +</dl> +</li> +</ul> +<a name="compute-org.apache.spark.Partition-org.apache.spark.TaskContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compute</h4> +<pre>public scala.collection.Iterator<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>>> compute(org.apache.spark.Partition split, + org.apache.spark.TaskContext context)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>compute</code> in class <code>org.apache.spark.rdd.RDD<org.apache.beam.sdk.util.WindowedValue<<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.html" title="type parameter in SourceRDD.Bounded">T</a>>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.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.Unbounded.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/SourceRDD.Bounded.html" target="_top">Frames</a></li> +<li><a href="SourceRDD.Bounded.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.spark.rdd.RDD">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html new file mode 100644 index 0000000..6581fab --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html @@ -0,0 +1,359 @@ +<!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 Fri May 12 16:50:05 PDT 2017 --> +<title>SourceRDD.Unbounded</title> +<meta name="date" content="2017-05-12"> +<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="SourceRDD.Unbounded"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/SourceRDD.Bounded.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/SparkUnboundedSource.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/SourceRDD.Unbounded.html" target="_top">Frames</a></li> +<li><a href="SourceRDD.Unbounded.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.spark.rdd.RDD">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 SourceRDD.Unbounded" class="title">Class SourceRDD.Unbounded<T,CheckpointMarkT extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.rdd.RDD<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><T>,CheckpointMarkT>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.spark.io.SourceRDD.Unbounded<T,CheckpointMarkT></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, org.apache.spark.Logging</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.html" title="class in org.apache.beam.runners.spark.io">SourceRDD</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">SourceRDD.Unbounded<T,CheckpointMarkT extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></span> +extends org.apache.spark.rdd.RDD<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><T>,CheckpointMarkT>></pre> +<div class="block">A <a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="class in org.apache.beam.runners.spark.io"><code>SourceRDD.Unbounded</code></a> is the implementation of a micro-batch + in a <code>SourceDStream</code>. + + <p>This RDD is made of P partitions, each containing a single pair-element of the partitioned + <a href="../../../../../../org/apache/beam/runners/spark/io/MicrobatchSource.html" title="class in org.apache.beam.runners.spark.io"><code>MicrobatchSource</code></a> and an optional starting <code>UnboundedSource.CheckpointMark</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.spark.io.SourceRDD.Unbounded">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.spark.rdd.RDD"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.spark.rdd.RDD</h3> +<code>org$apache$spark$rdd$RDD$$evidence$1</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"> </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="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html#Unbounded-org.apache.spark.SparkContext-org.apache.beam.runners.spark.translation.SparkRuntimeContext-org.apache.beam.runners.spark.io.MicrobatchSource-int-">Unbounded</a></span>(org.apache.spark.SparkContext sc, + org.apache.beam.runners.spark.translation.SparkRuntimeContext runtimeContext, + <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/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a>> microbatchSource, + int initialNumPartitions)</code> </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"> </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>scala.collection.Iterator<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html#compute-org.apache.spark.Partition-org.apache.spark.TaskContext-">compute</a></span>(org.apache.spark.Partition split, + org.apache.spark.TaskContext context)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.spark.Partition[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html#getPartitions--">getPartitions</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>scala.Option<org.apache.spark.Partitioner></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html#partitioner--">partitioner</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.rdd.RDD"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.spark.rdd.RDD</h3> +<code>$plus$plus, aggregate, cache, cartesian, checkpoint, checkpointData_$eq, checkpointData, clearDependencies, coalesce, coalesce$default$2, coalesce$default$3, collect, collect, collectPartitions, computeOrReadCheckpoint, conf, context, count, countApprox, countApprox$default$2, countApproxDistinct, countApproxDistinct, countApproxDistinct$default$1, countByValue, countByValue$default$1, countByValueApprox, countByValueApprox$default$2, countByValueApprox$default$3, creationSite, dependencies, distinct, distinct, distinct$default$2, doCheckpoint, doubleRDDToDoubleRDDFunctions, elementClassTag, filter, filterWith, first, firstParent, flatMap, flatMapWith, flatMapWith$default$2, fold, foreach, foreachPartition, foreachWith, getCheckpointFile, getCreationSite, getDependencies, getNarrowAncestors, getNumPartitions, getPreferredLocations, getStorageLevel, glom, groupBy, groupBy, groupBy, groupBy$default$4, id, intersection, intersection, intersection, intersection$default$3, isCheckp ointed, isCheckpointedAndMaterialized, isEmpty, isLocallyCheckpointed, isTraceEnabled, iterator, keyBy, localCheckpoint, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, map, mapPartitions, mapPartitions$default$2, mapPartitionsInternal, mapPartitionsInternal$default$2, mapPartitionsWithContext, mapPartitionsWithContext$default$2, mapPartitionsWithIndex, mapPartitionsWithIndex$default$2, mapPartitionsWithSplit, mapPartitionsWithSplit$default$2, mapWith, mapWith$default$2, markCheckpointed, max, min, name_$eq, name, numericRDDToDoubleRDDFunctions, org$apache$spark$Logging$$log__$eq, org$apache$spark$Logging$$log_, org$apache$spark$rdd$RDD$$debugString$1, org$apache$spark$rdd$RDD$$debugString$default$4$1, org$apache$spark$rdd$RDD$$dependencies__$eq, org$apache$spark$rdd$RDD$$dependencies_, org$apache$spark$rdd$RDD$$doCheckpointCalled_$eq, org$apache$spark$rdd$RDD$$doCheckpointCalled, org$apache$spark$rdd$RDD$$partition s__$eq, org$apache$spark$rdd$RDD$$partitions_, org$apache$spark$rdd$RDD$$sc, org$apache$spark$rdd$RDD$$visit$1, parent, partitions, persist, persist, pipe, pipe, pipe, pipe$default$2, pipe$default$3, pipe$default$4, pipe$default$5, preferredLocations, randomSampleWithRange, randomSplit, randomSplit$default$2, rddToAsyncRDDActions, rddToOrderedRDDFunctions, rddToPairRDDFunctions, rddToPairRDDFunctions$default$4, rddToSequenceFileRDDFunctions, reduce, repartition, repartition$default$2, retag, retag, sample, sample$default$3, saveAsObjectFile, saveAsTextFile, saveAsTextFile, scope, setName, sortBy, sortBy$default$2, sortBy$default$3, sparkContext, subtract, subtract, subtract, subtract$default$3, take, takeOrdered, takeSample, takeSample$default$3, toArray, toDebugString, toJavaRDD, toLocalIterator, top, toString, treeAggregate, treeAggregate$default$4, treeReduce, treeReduce$default$2, union, unpersist, unpersist$default$1, withScope, zip, zipPartitions, zipPartitions, zipPartitions, zipPartitions, zipPartitions, zipPartitions, zipWithIndex, zipWithUniqueId</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Unbounded-org.apache.spark.SparkContext-org.apache.beam.runners.spark.translation.SparkRuntimeContext-org.apache.beam.runners.spark.io.MicrobatchSource-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Unbounded</h4> +<pre>public Unbounded(org.apache.spark.SparkContext sc, + org.apache.beam.runners.spark.translation.SparkRuntimeContext runtimeContext, + <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/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a>> microbatchSource, + int initialNumPartitions)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPartitions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitions</h4> +<pre>public org.apache.spark.Partition[] getPartitions()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getPartitions</code> in class <code>org.apache.spark.rdd.RDD<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a> extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>>></code></dd> +</dl> +</li> +</ul> +<a name="partitioner--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partitioner</h4> +<pre>public scala.Option<org.apache.spark.Partitioner> partitioner()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>partitioner</code> in class <code>org.apache.spark.rdd.RDD<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a> extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>>></code></dd> +</dl> +</li> +</ul> +<a name="compute-org.apache.spark.Partition-org.apache.spark.TaskContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compute</h4> +<pre>public scala.collection.Iterator<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a>>> compute(org.apache.spark.Partition split, + org.apache.spark.TaskContext context)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>compute</code> in class <code>org.apache.spark.rdd.RDD<scala.Tuple2<<a href="../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">T</a>>,<a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Unbounded.html" title="type parameter in SourceRDD.Unbounded">CheckpointMarkT</a> extends <a href="../../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/beam/runners/spark/io/SourceRDD.Bounded.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/SparkUnboundedSource.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/SourceRDD.Unbounded.html" target="_top">Frames</a></li> +<li><a href="SourceRDD.Unbounded.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.spark.rdd.RDD">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
