blob: d98cd2f994e0f683668a700192bda8cfbedb7c17 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ContinuousIcebergEnumerator</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.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.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ContinuousIcebergEnumerator";
}
}
catch(err) {
}
//-->
var data = {"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";
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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a 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.enumerator</a></div>
<h2 title="Class ContinuousIcebergEnumerator" class="title">Class ContinuousIcebergEnumerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.flink.source.enumerator.ContinuousIcebergEnumerator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code>org.apache.flink.api.common.state.CheckpointListener</code>, <code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</code></dd>
</dl>
<hr>
<pre>@Internal
public class <span class="typeNameLabel">ContinuousIcebergEnumerator</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.flink.api.connector.source.SplitEnumeratorContext,org.apache.iceberg.flink.source.assigner.SplitAssigner,org.apache.iceberg.flink.source.ScanContext,org.apache.iceberg.flink.source.enumerator.ContinuousSplitPlanner,org.apache.iceberg.flink.source.enumerator.IcebergEnumeratorState)">ContinuousIcebergEnumerator</a></span>&#8203;(org.apache.flink.api.connector.source.SplitEnumeratorContext&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>&gt;&nbsp;enumeratorContext,
<a href="../assigner/SplitAssigner.html" title="interface in org.apache.iceberg.flink.source.assigner">SplitAssigner</a>&nbsp;assigner,
<a href="../ScanContext.html" title="class in org.apache.iceberg.flink.source">ScanContext</a>&nbsp;scanContext,
<a href="ContinuousSplitPlanner.html" title="interface in org.apache.iceberg.flink.source.enumerator">ContinuousSplitPlanner</a>&nbsp;splitPlanner,
<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&nbsp;enumState)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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="#addReader(int)">addReader</a></span>&#8203;(int&nbsp;subtaskId)</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="#addSplitsBack(java.util.List,int)">addSplitsBack</a></span>&#8203;(java.util.List&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>&gt;&nbsp;splits,
int&nbsp;subtaskId)</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="#close()">close</a></span>()</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="#handleSourceEvent(int,org.apache.flink.api.connector.source.SourceEvent)">handleSourceEvent</a></span>&#8203;(int&nbsp;subtaskId,
org.apache.flink.api.connector.source.SourceEvent&nbsp;sourceEvent)</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="#handleSplitRequest(int,java.lang.String)">handleSplitRequest</a></span>&#8203;(int&nbsp;subtaskId,
java.lang.String&nbsp;requesterHostname)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldWaitForMoreSplits()">shouldWaitForMoreSplits</a></span>()</code></th>
<td class="colLast">
<div class="block">return true if enumerator should wait for splits like in the continuous enumerator case</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshotState(long)">snapshotState</a></span>&#8203;(long&nbsp;checkpointId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<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</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.flink.api.connector.source.SplitEnumerator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.flink.api.connector.source.SplitEnumerator</h3>
<code>notifyCheckpointComplete</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.flink.api.connector.source.SplitEnumeratorContext,org.apache.iceberg.flink.source.assigner.SplitAssigner,org.apache.iceberg.flink.source.ScanContext,org.apache.iceberg.flink.source.enumerator.ContinuousSplitPlanner,org.apache.iceberg.flink.source.enumerator.IcebergEnumeratorState)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ContinuousIcebergEnumerator</h4>
<pre>public&nbsp;ContinuousIcebergEnumerator&#8203;(org.apache.flink.api.connector.source.SplitEnumeratorContext&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>&gt;&nbsp;enumeratorContext,
<a href="../assigner/SplitAssigner.html" title="interface in org.apache.iceberg.flink.source.assigner">SplitAssigner</a>&nbsp;assigner,
<a href="../ScanContext.html" title="class in org.apache.iceberg.flink.source">ScanContext</a>&nbsp;scanContext,
<a href="ContinuousSplitPlanner.html" title="interface in org.apache.iceberg.flink.source.enumerator">ContinuousSplitPlanner</a>&nbsp;splitPlanner,
@Nullable
<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&nbsp;enumState)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>start</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&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.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="shouldWaitForMoreSplits()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldWaitForMoreSplits</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;shouldWaitForMoreSplits()</pre>
<div class="block">return true if enumerator should wait for splits like in the continuous enumerator case</div>
</li>
</ul>
<a id="snapshotState(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshotState</h4>
<pre class="methodSignature">public&nbsp;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&nbsp;snapshotState&#8203;(long&nbsp;checkpointId)</pre>
</li>
</ul>
<a id="handleSplitRequest(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleSplitRequest</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleSplitRequest&#8203;(int&nbsp;subtaskId,
@Nullable
java.lang.String&nbsp;requesterHostname)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>handleSplitRequest</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="handleSourceEvent(int,org.apache.flink.api.connector.source.SourceEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleSourceEvent</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleSourceEvent&#8203;(int&nbsp;subtaskId,
org.apache.flink.api.connector.source.SourceEvent&nbsp;sourceEvent)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>handleSourceEvent</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="addSplitsBack(java.util.List,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSplitsBack</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addSplitsBack&#8203;(java.util.List&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>&gt;&nbsp;splits,
int&nbsp;subtaskId)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>addSplitsBack</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="addReader(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addReader</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addReader&#8203;(int&nbsp;subtaskId)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>addReader</code>&nbsp;in interface&nbsp;<code>org.apache.flink.api.connector.source.SplitEnumerator&lt;<a href="../split/IcebergSourceSplit.html" title="class in org.apache.iceberg.flink.source.split">IcebergSourceSplit</a>,&#8203;<a href="IcebergEnumeratorState.html" title="class in org.apache.iceberg.flink.source.enumerator">IcebergEnumeratorState</a>&gt;</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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>