| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TransactionContext (kafka 3.7.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.source, interface: TransactionContext"> |
| <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.6.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.source</a></div> |
| <h1 title="Interface TransactionContext" class="title">Interface TransactionContext</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TransactionContext</span></div> |
| <div class="block">Provided to source tasks to allow them to define their own producer transaction boundaries when |
| exactly-once support is enabled.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#abortTransaction()" class="member-name-link">abortTransaction</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Requests a transaction abort after the next batch of records from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#abortTransaction(org.apache.kafka.connect.source.SourceRecord)" class="member-name-link">abortTransaction</a><wbr>(<a href="SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Requests a transaction abort after a source record is processed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#commitTransaction()" class="member-name-link">commitTransaction</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Request a transaction commit after the next batch of records from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a> |
| is processed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#commitTransaction(org.apache.kafka.connect.source.SourceRecord)" class="member-name-link">commitTransaction</a><wbr>(<a href="SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Request a transaction commit after a source record is processed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="commitTransaction()"> |
| <h3>commitTransaction</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">commitTransaction</span>()</div> |
| <div class="block">Request a transaction commit after the next batch of records from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a> |
| is processed.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commitTransaction(org.apache.kafka.connect.source.SourceRecord)"> |
| <h3>commitTransaction</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">commitTransaction</span><wbr><span class="parameters">(<a href="SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record)</span></div> |
| <div class="block">Request a transaction commit after a source record is processed. The source record will be the |
| last record in the committed transaction. |
| <p> |
| If a task requests that the last record in a batch that it returns from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a> |
| be committed by invoking this method, and also requests that that same batch be aborted by |
| invoking <a href="#abortTransaction()"><code>abortTransaction()</code></a>, the record-based operation (in this case, committing |
| the transaction) will take precedence.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>record</code> - the record to commit the transaction after; may not be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortTransaction()"> |
| <h3>abortTransaction</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">abortTransaction</span>()</div> |
| <div class="block">Requests a transaction abort after the next batch of records from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a>. All of |
| the records in that transaction will be discarded and will not appear in a committed transaction. |
| However, offsets for that transaction will still be committed so than the records in that transaction |
| are not reprocessed. If the data should instead be reprocessed, the task should not invoke this method |
| and should instead throw an exception.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortTransaction(org.apache.kafka.connect.source.SourceRecord)"> |
| <h3>abortTransaction</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">abortTransaction</span><wbr><span class="parameters">(<a href="SourceRecord.html" title="class in org.apache.kafka.connect.source">SourceRecord</a> record)</span></div> |
| <div class="block">Requests a transaction abort after a source record is processed. The source record will be the |
| last record in the aborted transaction. All of the records in that transaction will be discarded |
| and will not appear in a committed transaction. However, offsets for that transaction will still |
| be committed so that the records in that transaction are not reprocessed. If the data should be |
| reprocessed, the task should not invoke this method and should instead throw an exception. |
| <p> |
| If a task requests that the last record in a batch that it returns from <a href="SourceTask.html#poll()"><code>SourceTask.poll()</code></a> |
| be aborted by invoking this method, and also requests that that same batch be committed by |
| invoking <a href="#commitTransaction()"><code>commitTransaction()</code></a>, the record-based operation (in this case, aborting |
| the transaction) will take precedence.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>record</code> - the record to abort the transaction after; may not be null.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
