blob: 31c6985d663649c068df65a33e0f47df481e1e09 [file] [log] [blame]
<!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 -->
<title>KafkaSourceConsumerFn (Apache Beam 2.47.0)</title>
<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="KafkaSourceConsumerFn (Apache Beam 2.47.0)";
}
}
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/io/debezium/KafkaConnectUtils.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/io/debezium/KafkaSourceConsumerFn.html" target="_top">Frames</a></li>
<li><a href="KafkaSourceConsumerFn.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.io.debezium</div>
<h2 title="Class KafkaSourceConsumerFn" class="title">Class KafkaSourceConsumerFn&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.DoFn</a>&lt;java.util.Map&lt;java.lang.String,java.lang.String&gt;,T&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.io.debezium.KafkaSourceConsumerFn&lt;T&gt;</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">KafkaSourceConsumerFn&lt;T&gt;</span>
extends <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a>&lt;java.util.Map&lt;java.lang.String,java.lang.String&gt;,T&gt;</pre>
<div class="block"><h3>Quick Overview</h3>
This is a Splittable <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> used to process records fetched from supported Debezium
Connectors.
<p>Currently it has a time limiter (see <code>OffsetTracker</code>) which, if set, it will stop
automatically after the specified elapsed minutes. Otherwise, it will keep running until the user
explicitly interrupts it.
<p>It might be initialized either as:
<pre>KafkaSourceConsumerFn(connectorClass, SourceRecordMapper, maxRecords, milisecondsToRun)
</pre>
Or with a time limiter:
<pre>KafkaSourceConsumerFn(connectorClass, SourceRecordMapper, minutesToRun)</pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.io.debezium.KafkaSourceConsumerFn">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">&nbsp;</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>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory.html" title="class in org.apache.beam.io.debezium">KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.AlwaysFetched.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.AlwaysFetched</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.BoundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.BoundedPerElement</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.BundleFinalizer.html" title="interface in org.apache.beam.sdk.transforms">DoFn.BundleFinalizer</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Element.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Element</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FieldAccess.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FieldAccess</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FinishBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.FinishBundleContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialRestriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialWatermarkEstimatorState</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetRestrictionCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetRestrictionCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetSize</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetWatermarkEstimatorStateCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetWatermarkEstimatorStateCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Key.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Key</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.MultiOutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.MultiOutputReceiver</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewTracker</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewWatermarkEstimator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimer.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimer</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnTimerContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimerFamily</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpiration.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnWindowExpiration</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpirationContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnWindowExpirationContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="type parameter in DoFn.OutputReceiver">T</a>&gt;, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.ProcessElement</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresStableInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresStableInput</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresTimeSortedInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresTimeSortedInput</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Restriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Restriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Setup</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SideInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SideInput</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SplitRestriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StartBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.StartBundleContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StateId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StateId</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Teardown.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Teardown</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerFamily</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TimerId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerId</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Timestamp.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Timestamp</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TruncateRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TruncateRestriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.UnboundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.UnboundedPerElement</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.WatermarkEstimatorState</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WindowedContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.WindowedContext</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#BEAM_INSTANCE_PROPERTY">BEAM_INSTANCE_PROPERTY</a></span></code>&nbsp;</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">&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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#getHashCode--">getHashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#getInitialRestriction-java.util.Map-">getInitialRestriction</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;unused)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/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/io/debezium/KafkaSourceConsumerFn.html#getInitialWatermarkEstimatorState-org.joda.time.Instant-">getInitialWatermarkEstimatorState</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;currentElementTimestamp)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected org.apache.kafka.connect.source.SourceRecord</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#getOneRecord-java.util.Map-">getOneRecord</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;configuration)</code>&nbsp;</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>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#getRestrictionCoder--">getRestrictionCoder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder,java.util.Map&lt;java.lang.String,java.lang.Object&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#newTracker-org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder-">newTracker</a></span>(org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder&nbsp;restriction)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimator</a>&lt;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#newWatermarkEstimator-org.joda.time.Instant-">newWatermarkEstimator</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;watermarkEstimatorState)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html#process-java.util.Map-org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker-org.apache.beam.sdk.transforms.DoFn.OutputReceiver-">process</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder,java.util.Map&lt;java.lang.String,java.lang.Object&gt;&gt;&nbsp;tracker,
<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a>&lt;<a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html" title="type parameter in KafkaSourceConsumerFn">T</a>&gt;&nbsp;receiver)</code>
<div class="block">Process the retrieved element and format it for output.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getInputTypeDescriptor--">getInputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#prepareForProcessing--">prepareForProcessing</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&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="BEAM_INSTANCE_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BEAM_INSTANCE_PROPERTY</h4>
<pre>public static final&nbsp;java.lang.String BEAM_INSTANCE_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.beam.io.debezium.KafkaSourceConsumerFn.BEAM_INSTANCE_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInitialRestriction-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialRestriction</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.GetInitialRestriction</a>
public&nbsp;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder&nbsp;getInitialRestriction(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Element.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.Element</a>
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;unused)
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="newTracker-org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newTracker</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.NewTracker</a>
public&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder,java.util.Map&lt;java.lang.String,java.lang.Object&gt;&gt;&nbsp;newTracker(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Restriction.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.Restriction</a>
org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder&nbsp;restriction)</pre>
</li>
</ul>
<a name="getRestrictionCoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRestrictionCoder</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetRestrictionCoder.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.GetRestrictionCoder</a>
public&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder&gt;&nbsp;getRestrictionCoder()</pre>
</li>
</ul>
<a name="getOneRecord-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOneRecord</h4>
<pre>protected&nbsp;org.apache.kafka.connect.source.SourceRecord&nbsp;getOneRecord(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;configuration)</pre>
</li>
</ul>
<a name="getInitialWatermarkEstimatorState-org.joda.time.Instant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialWatermarkEstimatorState</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.GetInitialWatermarkEstimatorState</a>
public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;getInitialWatermarkEstimatorState(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Timestamp.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.Timestamp</a>
<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;currentElementTimestamp)</pre>
</li>
</ul>
<a name="newWatermarkEstimator-org.joda.time.Instant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newWatermarkEstimator</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.NewWatermarkEstimator</a>
public&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/WatermarkEstimator.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">WatermarkEstimator</a>&lt;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&gt;&nbsp;newWatermarkEstimator(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.WatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.WatermarkEstimatorState</a>
<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;watermarkEstimatorState)</pre>
</li>
</ul>
<a name="process-java.util.Map-org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker-org.apache.beam.sdk.transforms.DoFn.OutputReceiver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>process</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.ProcessElement</a>
public&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a>&nbsp;process(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Element.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.Element</a>
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;element,
<a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="class in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a>&lt;org.apache.beam.io.debezium.KafkaSourceConsumerFn.OffsetHolder,java.util.Map&lt;java.lang.String,java.lang.Object&gt;&gt;&nbsp;tracker,
<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a>&lt;<a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.html" title="type parameter in KafkaSourceConsumerFn">T</a>&gt;&nbsp;receiver)
throws java.lang.Exception</pre>
<div class="block">Process the retrieved element and format it for output. Update all pending</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - A descriptor for the configuration of the <code>SourceConnector</code> and <code>SourceTask</code> instances.</dd>
<dd><code>tracker</code> - Restriction Tracker</dd>
<dd><code>receiver</code> - Output Receiver</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn.ProcessContinuation</code></a> in most cases, to
continue processing after 1 second. Otherwise, if we've reached a limit of elements, to
stop processing.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getHashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHashCode</h4>
<pre>public&nbsp;java.lang.String&nbsp;getHashCode()</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/io/debezium/KafkaConnectUtils.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/io/debezium/KafkaSourceConsumerFn.html" target="_top">Frames</a></li>
<li><a href="KafkaSourceConsumerFn.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>