blob: bfa4d045048f2b7cc2457f8f79e0bfd89b4732a8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>StreamingReaderOperator</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StreamingReaderOperator";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.flink.source</a></div>
<h2 title="Class StreamingReaderOperator" class="title">Class StreamingReaderOperator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.flink.source.StreamingReaderOperator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>org.apache.flink.api.common.state.CheckpointListener</code>, <code>org.apache.flink.streaming.api.operators.Input&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>&gt;</code>, <code>org.apache.flink.streaming.api.operators.KeyContext</code>, <code>org.apache.flink.streaming.api.operators.OneInputStreamOperator&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>,&#8203;org.apache.flink.table.data.RowData&gt;</code>, <code>org.apache.flink.streaming.api.operators.SetupableStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code>, <code>org.apache.flink.streaming.api.operators.StreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code>, <code>org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">StreamingReaderOperator</span>
extends org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;
implements org.apache.flink.streaming.api.operators.OneInputStreamOperator&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>,&#8203;org.apache.flink.table.data.RowData&gt;</pre>
<div class="block">The operator that reads the <a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source"><code>splits</code></a> received from the preceding <a href="StreamingMonitorFunction.html" title="class in org.apache.iceberg.flink.source"><code>StreamingMonitorFunction</code></a>. Contrary to the <a href="StreamingMonitorFunction.html" title="class in org.apache.iceberg.flink.source"><code>StreamingMonitorFunction</code></a> which has a
parallelism of 1, this operator can have multiple parallelism.
<p>As soon as a split descriptor is received, it is put in a queue, and use <code>MailboxExecutor</code> read the actual data of the split. This architecture allows the separation of
the reading thread from the one split processing the checkpoint barriers, thus removing any
potential back-pressure.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.iceberg.flink.source.StreamingReaderOperator">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.flink.streaming.api.operators.AbstractStreamOperator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.flink.streaming.api.operators.AbstractStreamOperator</h3>
<code>chainingStrategy, config, latencyStats, metrics, output, processingTimeService</code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finish()">finish</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initializeState(org.apache.flink.runtime.state.StateInitializationContext)">initializeState</a></span>&#8203;(org.apache.flink.runtime.state.StateInitializationContext&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processElement(org.apache.flink.streaming.runtime.streamrecord.StreamRecord)">processElement</a></span>&#8203;(org.apache.flink.streaming.runtime.streamrecord.StreamRecord&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>&gt;&nbsp;element)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processWatermark(org.apache.flink.streaming.api.watermark.Watermark)">processWatermark</a></span>&#8203;(org.apache.flink.streaming.api.watermark.Watermark&nbsp;mark)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshotState(org.apache.flink.runtime.state.StateSnapshotContext)">snapshotState</a></span>&#8203;(org.apache.flink.runtime.state.StateSnapshotContext&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.streaming.api.operators.AbstractStreamOperator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.flink.streaming.api.operators.AbstractStreamOperator</h3>
<code>getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, open, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, registerCounterOnOutput, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setProcessingTimeService, setup, snapshotState</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.api.common.state.CheckpointListener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.api.common.state.CheckpointListener</h3>
<code>notifyCheckpointAborted, notifyCheckpointComplete</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.streaming.api.operators.Input">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.streaming.api.operators.Input</h3>
<code>processLatencyMarker, processWatermarkStatus</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.streaming.api.operators.KeyContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.streaming.api.operators.KeyContext</h3>
<code>getCurrentKey, setCurrentKey</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.streaming.api.operators.OneInputStreamOperator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.streaming.api.operators.OneInputStreamOperator</h3>
<code>setKeyContextElement</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.streaming.api.operators.StreamOperator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.streaming.api.operators.StreamOperator</h3>
<code>getMetricGroup, getOperatorID, initializeState, open, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initializeState(org.apache.flink.runtime.state.StateInitializationContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initializeState&#8203;(org.apache.flink.runtime.state.StateInitializationContext&nbsp;context)
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>initializeState</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>initializeState</code>&nbsp;in class&nbsp;<code>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="snapshotState(org.apache.flink.runtime.state.StateSnapshotContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshotState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;snapshotState&#8203;(org.apache.flink.runtime.state.StateSnapshotContext&nbsp;context)
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>snapshotState</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>snapshotState</code>&nbsp;in class&nbsp;<code>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="processElement(org.apache.flink.streaming.runtime.streamrecord.StreamRecord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processElement</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;processElement&#8203;(org.apache.flink.streaming.runtime.streamrecord.StreamRecord&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>&gt;&nbsp;element)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>processElement</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.Input&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="processWatermark(org.apache.flink.streaming.api.watermark.Watermark)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processWatermark</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;processWatermark&#8203;(org.apache.flink.streaming.api.watermark.Watermark&nbsp;mark)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>processWatermark</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.Input&lt;<a href="FlinkInputSplit.html" title="class in org.apache.iceberg.flink.source">FlinkInputSplit</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>processWatermark</code>&nbsp;in class&nbsp;<code>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.StreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="finish()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finish</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;finish()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>finish</code>&nbsp;in interface&nbsp;<code>org.apache.flink.streaming.api.operators.StreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>finish</code>&nbsp;in class&nbsp;<code>org.apache.flink.streaming.api.operators.AbstractStreamOperator&lt;org.apache.flink.table.data.RowData&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>