| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MockSinkConnector (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: MockSinkConnector"> |
| <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>Nested | </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>Field | </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 MockSinkConnector" class="title">Class MockSinkConnector</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="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">org.apache.kafka.connect.connector.Connector</a> |
| <div class="inheritance"><a href="../sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">org.apache.kafka.connect.sink.SinkConnector</a> |
| <div class="inheritance">org.apache.kafka.connect.tools.MockSinkConnector</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../components/Versioned.html" title="interface in org.apache.kafka.connect.components">Versioned</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MockSinkConnector</span> |
| <span class="extends-implements">extends <a href="../sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">SinkConnector</a></span></div> |
| <div class="block">Mock sink implementation which delegates to <a href="MockConnector.html" title="class in org.apache.kafka.connect.tools"><code>MockConnector</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.kafka.connect.sink.SinkConnector">Fields inherited from class org.apache.kafka.connect.sink.<a href="../sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">SinkConnector</a></h3> |
| <code><a href="../sink/SinkConnector.html#TOPICS_CONFIG">TOPICS_CONFIG</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.kafka.connect.connector.Connector">Fields inherited from class org.apache.kafka.connect.connector.<a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></h3> |
| <code><a href="../connector/Connector.html#context">context</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">MockSinkConnector</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><a href="../../common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#config()" class="member-name-link">config</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define the configuration for the connector.</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="#initialize(org.apache.kafka.connect.connector.ConnectorContext)" class="member-name-link">initialize</a><wbr>(<a href="../connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Initialize this connector, using the provided ConnectorContext to notify the runtime of |
| input configuration changes.</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="#initialize(org.apache.kafka.connect.connector.ConnectorContext,java.util.List)" class="member-name-link">initialize</a><wbr>(<a href="../connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx, |
| <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="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>>> taskConfigs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"> |
| Initialize this connector, using the provided ConnectorContext to notify the runtime of |
| input configuration changes and using the provided set of Task configurations.</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="#reconfigure(java.util.Map)" class="member-name-link">reconfigure</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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reconfigure this Connector.</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 this Connector.</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">Stop this connector.</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#taskClass()" class="member-name-link">taskClass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the <a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector"><code>Task</code></a> implementation for this Connector.</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="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>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#taskConfigs(int)" class="member-name-link">taskConfigs</a><wbr>(int maxTasks)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a set of configurations for Tasks based on the current configuration, |
| producing at most <code>maxTasks</code> configurations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../common/config/Config.html" title="class in org.apache.kafka.common.config">Config</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.util.Map)" class="member-name-link">validate</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>> connectorConfigs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validate the connector configuration values against configuration definitions.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the version of this component.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.connect.sink.SinkConnector">Methods inherited from class org.apache.kafka.connect.sink.<a href="../sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">SinkConnector</a></h3> |
| <code><a href="../sink/SinkConnector.html#alterOffsets(java.util.Map,java.util.Map)">alterOffsets</a>, <a href="../sink/SinkConnector.html#context()">context</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"> |
| <!-- ========= 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>MockSinkConnector</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MockSinkConnector</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="initialize(org.apache.kafka.connect.connector.ConnectorContext)"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span><wbr><span class="parameters">(<a href="../connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext)">Connector</a></code></span></div> |
| <div class="block">Initialize this connector, using the provided ConnectorContext to notify the runtime of |
| input configuration changes.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext)">initialize</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ctx</code> - context object used to interact with the Kafka Connect runtime</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initialize(org.apache.kafka.connect.connector.ConnectorContext,java.util.List)"> |
| <h3>initialize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span><wbr><span class="parameters">(<a href="../connector/ConnectorContext.html" title="interface in org.apache.kafka.connect.connector">ConnectorContext</a> ctx, |
| <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="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>>> taskConfigs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext,java.util.List)">Connector</a></code></span></div> |
| <div class="block"><p> |
| Initialize this connector, using the provided ConnectorContext to notify the runtime of |
| input configuration changes and using the provided set of Task configurations. |
| This version is only used to recover from failures. |
| </p> |
| <p> |
| The default implementation ignores the provided Task configurations. During recovery, Kafka Connect will request |
| an updated set of configurations and update the running Tasks appropriately. However, Connectors should |
| implement special handling of this case if it will avoid unnecessary changes to running Tasks. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext,java.util.List)">initialize</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ctx</code> - context object used to interact with the Kafka Connect runtime</dd> |
| <dd><code>taskConfigs</code> - existing task configurations, which may be used when generating new task configs to avoid |
| churn in partition to task assignments</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reconfigure(java.util.Map)"> |
| <h3>reconfigure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reconfigure</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="../connector/Connector.html#reconfigure(java.util.Map)">Connector</a></code></span></div> |
| <div class="block">Reconfigure this Connector. Most implementations will not override this, using the default |
| implementation that calls <a href="../connector/Connector.html#stop()"><code>Connector.stop()</code></a> followed by <a href="../connector/Connector.html#start(java.util.Map)"><code>Connector.start(Map)</code></a>. |
| Implementations only need to override this if they want to handle this process more |
| efficiently, e.g. without shutting down network connections to the external system.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../connector/Connector.html#reconfigure(java.util.Map)">reconfigure</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>props</code> - new configuration settings</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.util.Map)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/config/Config.html" title="class in org.apache.kafka.common.config">Config</a></span> <span class="element-name">validate</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>> connectorConfigs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#validate(java.util.Map)">Connector</a></code></span></div> |
| <div class="block">Validate the connector configuration values against configuration definitions.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../connector/Connector.html#validate(java.util.Map)">validate</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>connectorConfigs</code> - the provided configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>a parsed and validated <a href="../../common/config/Config.html" title="class in org.apache.kafka.common.config"><code>Config</code></a> containing any relevant validation errors with the raw |
| <code>connectorConfigs</code> which should prevent this configuration from being used.</dd> |
| </dl> |
| </section> |
| </li> |
| <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="../components/Versioned.html#version()">Versioned</a></code></span></div> |
| <div class="block">Get the version of this component.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the version, formatted as a String. The version may not be <code>null</code> or empty.</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="../connector/Connector.html#start(java.util.Map)">Connector</a></code></span></div> |
| <div class="block">Start this Connector. This method will only be called on a clean Connector, i.e. it has |
| either just been instantiated and initialized or <a href="../connector/Connector.html#stop()"><code>Connector.stop()</code></a> has been invoked.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Connector.html#start(java.util.Map)">start</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>props</code> - configuration settings</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="taskClass()"> |
| <h3>taskClass</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a>></span> <span class="element-name">taskClass</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#taskClass()">Connector</a></code></span></div> |
| <div class="block">Returns the <a href="../connector/Task.html" title="interface in org.apache.kafka.connect.connector"><code>Task</code></a> implementation for this Connector.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Connector.html#taskClass()">taskClass</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="taskConfigs(int)"> |
| <h3>taskConfigs</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="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>>></span> <span class="element-name">taskConfigs</span><wbr><span class="parameters">(int maxTasks)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#taskConfigs(int)">Connector</a></code></span></div> |
| <div class="block">Returns a set of configurations for Tasks based on the current configuration, |
| producing at most <code>maxTasks</code> configurations.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Connector.html#taskConfigs(int)">taskConfigs</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>maxTasks</code> - maximum number of configurations to generate</dd> |
| <dt>Returns:</dt> |
| <dd>configurations for Tasks</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="../connector/Connector.html#stop()">Connector</a></code></span></div> |
| <div class="block">Stop this connector.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Connector.html#stop()">stop</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="config()"> |
| <h3>config</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">config</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../connector/Connector.html#config()">Connector</a></code></span></div> |
| <div class="block">Define the configuration for the connector.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../connector/Connector.html#config()">config</a></code> in class <code><a href="../connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The ConfigDef for this connector; may not be null.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |