| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>VerifiableSourceTask (kafka 3.6.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.connect.tools, class: VerifiableSourceTask"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/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="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.connect.tools</a></div> |
| <h1 title="Class VerifiableSourceTask" class="title">Class VerifiableSourceTask</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">org.apache.kafka.connect.source.SourceTask</a> |
| <div class="inheritance">org.apache.kafka.connect.tools.VerifiableSourceTask</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">VerifiableSourceTask</span> |
| <span class="extends-implements">extends <a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></span></div> |
| <div class="block">A connector primarily intended for system tests. The connector simply generates as many tasks as requested. The |
| tasks print metadata in the form of JSON to stdout for each message generated, making externally visible which |
| messages have been sent. Each message is also assigned a unique, increasing seqno that is passed to Kafka Connect; when |
| tasks are started on new nodes, this seqno is used to resume where the task previously left off, allowing for |
| testing of distributed Kafka Connect. |
| <p> |
| If logging is left enabled, log output on stdout can be easily ignored by checking whether a given line is valid JSON.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.kafka.connect.source.SourceTask">Nested classes/interfaces inherited from class org.apache.kafka.connect.source.<a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></h2> |
| <code><a href="../source/SourceTask.TransactionBoundary.html" title="enum class in org.apache.kafka.connect.source">SourceTask.TransactionBoundary</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#COMPLETE_RECORD_DATA_CONFIG" class="member-name-link">COMPLETE_RECORD_DATA_CONFIG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#ID_CONFIG" class="member-name-link">ID_CONFIG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#NAME_CONFIG" class="member-name-link">NAME_CONFIG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#THROUGHPUT_CONFIG" class="member-name-link">THROUGHPUT_CONFIG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#TOPIC_CONFIG" class="member-name-link">TOPIC_CONFIG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.kafka.connect.source.SourceTask">Fields inherited from class org.apache.kafka.connect.source.<a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></h3> |
| <code><a href="../source/SourceTask.html#context">context</a>, <a href="../source/SourceTask.html#TRANSACTION_BOUNDARY_CONFIG">TRANSACTION_BOUNDARY_CONFIG</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">VerifiableSourceTask</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commitRecord(org.apache.kafka.connect.source.SourceRecord,org.apache.kafka.clients.producer.RecordMetadata)" class="member-name-link">commitRecord</a><wbr>(<a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record, |
| <a href="../../clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</a> metadata)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"> |
| Commit an individual <a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source"><code>SourceRecord</code></a> when the callback from the producer client is received.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#poll()" class="member-name-link">poll</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Poll this source task for new records.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(java.util.Map)" class="member-name-link">start</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Start the Task.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Signal this SourceTask to stop.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#version()" class="member-name-link">version</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the version of this task.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.connect.source.SourceTask">Methods inherited from class org.apache.kafka.connect.source.<a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></h3> |
| <code><a href="../source/SourceTask.html#commit()">commit</a>, <a href="../source/SourceTask.html#commitRecord(org.apache.kafka.connect.source.SourceRecord)">commitRecord</a>, <a href="../source/SourceTask.html#initialize(org.apache.kafka.connect.source.SourceTaskContext)">initialize</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="NAME_CONFIG"> |
| <h3>NAME_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">NAME_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.tools.VerifiableSourceTask.NAME_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ID_CONFIG"> |
| <h3>ID_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">ID_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.tools.VerifiableSourceTask.ID_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TOPIC_CONFIG"> |
| <h3>TOPIC_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TOPIC_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.tools.VerifiableSourceTask.TOPIC_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="THROUGHPUT_CONFIG"> |
| <h3>THROUGHPUT_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">THROUGHPUT_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.tools.VerifiableSourceTask.THROUGHPUT_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COMPLETE_RECORD_DATA_CONFIG"> |
| <h3>COMPLETE_RECORD_DATA_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">COMPLETE_RECORD_DATA_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.tools.VerifiableSourceTask.COMPLETE_RECORD_DATA_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>VerifiableSourceTask</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">VerifiableSourceTask</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="version()"> |
| <h3>version</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">version</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../connector/Task.html#version()">Task</a></code></span></div> |
| <div class="block">Get the version of this task. Usually this should be the same as the corresponding <a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector"><code>Connector</code></a> class's version.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the version, formatted as a String</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start(java.util.Map)"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../source/SourceTask.html#start(java.util.Map)">SourceTask</a></code></span></div> |
| <div class="block">Start the Task. This should handle any configuration parsing and one-time setup of the task.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Task.html#start(java.util.Map)">start</a></code> in interface <code><a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../source/SourceTask.html#start(java.util.Map)">start</a></code> in class <code><a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>props</code> - initial configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="poll()"> |
| <h3>poll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a>></span> <span class="element-name">poll</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../source/SourceTask.html#poll()">SourceTask</a></code></span></div> |
| <div class="block">Poll this source task for new records. If no data is currently available, this method |
| should block but return control to the caller regularly (by returning <code>null</code>) in |
| order for the task to transition to the <code>PAUSED</code> state if requested to do so. |
| <p> |
| The task will be <a href="../source/SourceTask.html#stop()"><code>stopped</code></a> on a separate thread, and when that happens |
| this method is expected to unblock, quickly finish up any remaining processing, and |
| return.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../source/SourceTask.html#poll()">poll</a></code> in class <code><a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a list of source records</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commitRecord(org.apache.kafka.connect.source.SourceRecord,org.apache.kafka.clients.producer.RecordMetadata)"> |
| <h3>commitRecord</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">commitRecord</span><wbr><span class="parameters">(<a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record, |
| <a href="../../clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer">RecordMetadata</a> metadata)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../source/SourceTask.html#commitRecord(org.apache.kafka.connect.source.SourceRecord,org.apache.kafka.clients.producer.RecordMetadata)">SourceTask</a></code></span></div> |
| <div class="block"><p> |
| Commit an individual <a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source"><code>SourceRecord</code></a> when the callback from the producer client is received. This method is |
| also called when a record is filtered by a transformation or when "errors.tolerance" is set to "all" |
| and thus will never be ACK'd by a broker. |
| In both cases <code>metadata</code> will be null. |
| <p> |
| SourceTasks are not required to implement this functionality; Kafka Connect will record offsets |
| automatically. This hook is provided for systems that also need to store offsets internally |
| in their own system. |
| <p> |
| The default implementation just calls <a href="../source/SourceTask.html#commitRecord(org.apache.kafka.connect.source.SourceRecord)"><code>SourceTask.commitRecord(SourceRecord)</code></a>, which is a nop by default. It is |
| not necessary to implement both methods.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../source/SourceTask.html#commitRecord(org.apache.kafka.connect.source.SourceRecord,org.apache.kafka.clients.producer.RecordMetadata)">commitRecord</a></code> in class <code><a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>record</code> - <a href="../source/SourceRecord.html" title="class in org.apache.kafka.connect.source"><code>SourceRecord</code></a> that was successfully sent via the producer, filtered by a transformation, or dropped on producer exception</dd> |
| <dd><code>metadata</code> - <a href="../../clients/producer/RecordMetadata.html" title="class in org.apache.kafka.clients.producer"><code>RecordMetadata</code></a> record metadata returned from the broker, or null if the record was filtered or if producer exceptions are ignored</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop()"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">stop</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../source/SourceTask.html#stop()">SourceTask</a></code></span></div> |
| <div class="block">Signal this SourceTask to stop. In SourceTasks, this method only needs to signal to the task that it should stop |
| trying to poll for new data and interrupt any outstanding poll() requests. It is not required that the task has |
| fully stopped. Note that this method necessarily may be invoked from a different thread than <a href="../source/SourceTask.html#poll()"><code>SourceTask.poll()</code></a> and |
| <a href="../source/SourceTask.html#commit()"><code>SourceTask.commit()</code></a>. |
| <p> |
| For example, if a task uses a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/Selector.html" title="class or interface in java.nio.channels" class="external-link"><code>Selector</code></a> to receive data over the network, this method |
| could set a flag that will force <a href="../source/SourceTask.html#poll()"><code>SourceTask.poll()</code></a> to exit immediately and invoke |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/Selector.html#wakeup()" title="class or interface in java.nio.channels" class="external-link"><code>wakeup()</code></a> to interrupt any ongoing requests.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Task.html#stop()">stop</a></code> in interface <code><a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../source/SourceTask.html#stop()">stop</a></code> in class <code><a href="../source/SourceTask.html" title="class in org.apache.kafka.connect.source">SourceTask</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
