| <!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_181-google-v7) on Mon Jan 27 16:42:29 PST 2020 --> |
| <title>HadoopFormatIO.HadoopInputFormatBoundedSource (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="HadoopFormatIO.HadoopInputFormatBoundedSource (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| 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/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Read.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" target="_top">Frames</a></li> |
| <li><a href="HadoopFormatIO.HadoopInputFormatBoundedSource.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.beam.sdk.io.BoundedSource">Nested</a> | </li> |
| <li>Field | </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.sdk.io.hadoop.format</div> |
| <h2 title="Class HadoopFormatIO.HadoopInputFormatBoundedSource" class="title">Class HadoopFormatIO.HadoopInputFormatBoundedSource<K,V></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><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.BoundedSource</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.HadoopInputFormatBoundedSource<K,V></li> |
| </ul> |
| </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>K</code> - Type of keys to be read.</dd> |
| <dd><code>V</code> - Type of values to be read.</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> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">HadoopFormatIO.HadoopInputFormatBoundedSource<K,V></span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>> |
| implements java.io.Serializable</pre> |
| <div class="block">Bounded source implementation for <a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><code>HadoopFormatIO</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.HadoopInputFormatBoundedSource">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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.BoundedSource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a></h3> |
| <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/sdk/io/BoundedSource.BoundedReader.html" title="type parameter in BoundedSource.BoundedReader">T</a>></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.Source"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces 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.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="type parameter in Source.Reader">T</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#HadoopInputFormatBoundedSource-org.apache.beam.sdk.io.hadoop.SerializableConfiguration-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.SimpleFunction-org.apache.beam.sdk.transforms.SimpleFunction-org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.SerializableSplit-">HadoopInputFormatBoundedSource</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/SerializableConfiguration.html" title="class in org.apache.beam.sdk.io.hadoop">SerializableConfiguration</a> conf, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>> keyCoder, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>> valueCoder, |
| <a href="../../../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a><?,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>> keyTranslationFunction, |
| <a href="../../../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a><?,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>> valueTranslationFunction, |
| <a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.SerializableSplit.html" title="class in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.SerializableSplit</a> inputSplit)</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>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#createInputFormatInstance--">createInputFormatInstance</a></span>()</code> |
| <div class="block">Creates instance of InputFormat class.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#createReader-org.apache.beam.sdk.options.PipelineOptions-">createReader</a></span>(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> |
| <div class="block">Returns a new <a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource.BoundedReader</code></a> that reads from this source.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/SerializableConfiguration.html" title="class in org.apache.beam.sdk.io.hadoop">SerializableConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#getConfiguration--">getConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#getEstimatedSizeBytes-org.apache.beam.sdk.options.PipelineOptions-">getEstimatedSizeBytes</a></span>(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> po)</code> |
| <div class="block">An estimate of the total size (in bytes) of the data that would be read from this source.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#getOutputCoder--">getOutputCoder</a></span>()</code> |
| <div class="block">Returns the <code>Coder</code> to use for the data read from this source.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</code> |
| <div class="block">Register display data for the given transform or component.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html#split-long-org.apache.beam.sdk.options.PipelineOptions-">split</a></span>(long desiredBundleSizeBytes, |
| <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> |
| <div class="block">Splits the source into bundles of approximately <code>desiredBundleSizeBytes</code>.</div> |
| </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/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.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#getDefaultOutputCoder--">getDefaultOutputCoder</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HadoopInputFormatBoundedSource-org.apache.beam.sdk.io.hadoop.SerializableConfiguration-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.SimpleFunction-org.apache.beam.sdk.transforms.SimpleFunction-org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.SerializableSplit-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HadoopInputFormatBoundedSource</h4> |
| <pre>protected HadoopInputFormatBoundedSource(<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/SerializableConfiguration.html" title="class in org.apache.beam.sdk.io.hadoop">SerializableConfiguration</a> conf, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>> keyCoder, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>> valueCoder, |
| <a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| <a href="../../../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a><?,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>> keyTranslationFunction, |
| <a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| <a href="../../../../../../../org/apache/beam/sdk/transforms/SimpleFunction.html" title="class in org.apache.beam.sdk.transforms">SimpleFunction</a><?,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>> valueTranslationFunction, |
| <a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.SerializableSplit.html" title="class in org.apache.beam.sdk.io.hadoop.format">HadoopFormatIO.SerializableSplit</a> inputSplit)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/hadoop/SerializableConfiguration.html" title="class in org.apache.beam.sdk.io.hadoop">SerializableConfiguration</a> getConfiguration()</pre> |
| </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 <code>Preconditions</code> for implementing this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>populateDisplayData</h4> |
| <pre>public void populateDisplayData(<a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">Source</a></code></span></div> |
| <div class="block">Register display data for the given transform or component. |
| |
| <p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect |
| display data via <a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace, |
| but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace |
| of the subcomponent. |
| |
| <p>By default, does not register any display data. Implementors may override this method to |
| provide their own display data.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in interface <code><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>builder</code> - The builder to populate with display data.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="split-long-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><<a href="../../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>>> split(long desiredBundleSizeBytes, |
| <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#split-long-org.apache.beam.sdk.options.PipelineOptions-">BoundedSource</a></code></span></div> |
| <div class="block">Splits the source into bundles of approximately <code>desiredBundleSizeBytes</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#split-long-org.apache.beam.sdk.options.PipelineOptions-">split</a></code> in class <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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEstimatedSizeBytes-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEstimatedSizeBytes</h4> |
| <pre>public long getEstimatedSizeBytes(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> po) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#getEstimatedSizeBytes-org.apache.beam.sdk.options.PipelineOptions-">BoundedSource</a></code></span></div> |
| <div class="block">An estimate of the total size (in bytes) of the data that would be read from this source. This |
| estimate is in terms of external storage size, before any decompression or other processing |
| done by the reader. |
| |
| <p>If there is no way to estimate the size of the source implementations MAY return 0L.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#getEstimatedSizeBytes-org.apache.beam.sdk.options.PipelineOptions-">getEstimatedSizeBytes</a></code> in class <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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createInputFormatInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createInputFormatInstance</h4> |
| <pre>protected void createInputFormatInstance() |
| throws java.io.IOException</pre> |
| <div class="block">Creates instance of InputFormat class. The InputFormat class name is specified in the Hadoop |
| configuration.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputCoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputCoder</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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>> getOutputCoder()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#getOutputCoder--">Source</a></code></span></div> |
| <div class="block">Returns the <code>Coder</code> to use for the data read from this source.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#getOutputCoder--">getOutputCoder</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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createReader-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createReader</h4> |
| <pre>public <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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>> createReader(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#createReader-org.apache.beam.sdk.options.PipelineOptions-">BoundedSource</a></code></span></div> |
| <div class="block">Returns a new <a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource.BoundedReader</code></a> that reads from this source.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html#createReader-org.apache.beam.sdk.options.PipelineOptions-">createReader</a></code> in class <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/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">K</a>,<a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" title="type parameter in HadoopFormatIO.HadoopInputFormatBoundedSource">V</a>>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</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/sdk/io/hadoop/format/HadoopFormatIO.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.Read.html" title="class in org.apache.beam.sdk.io.hadoop.format"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/hadoop/format/HadoopFormatIO.HadoopInputFormatBoundedSource.html" target="_top">Frames</a></li> |
| <li><a href="HadoopFormatIO.HadoopInputFormatBoundedSource.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.classes.inherited.from.class.org.apache.beam.sdk.io.BoundedSource">Nested</a> | </li> |
| <li>Field | </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> |
