http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/SinkConnector.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/SinkConnector.html b/0100/javadoc/org/apache/kafka/connect/sink/SinkConnector.html new file mode 100644 index 0000000..3979845 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/SinkConnector.html @@ -0,0 +1,294 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:05 BST 2016 --> +<title>SinkConnector (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SinkConnector (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkConnector.html" target="_top">Frames</a></li> +<li><a href="SinkConnector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_org.apache.kafka.connect.connector.Connector">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.kafka.connect.sink</div> +<h2 title="Class SinkConnector" class="title">Class SinkConnector</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector">org.apache.kafka.connect.connector.Connector</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.connect.sink.SinkConnector</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public abstract class <span class="strong">SinkConnector</span> +extends <a href="../../../../../org/apache/kafka/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></pre> +<div class="block">SinkConnectors implement the Connector interface to send Kafka data to another system.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkConnector.html#TOPICS_CONFIG">TOPICS_CONFIG</a></strong></code> +<div class="block"> + Configuration key for the list of input topics for this connector.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.kafka.connect.connector.Connector"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.kafka.connect.connector.<a href="../../../../../org/apache/kafka/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></h3> +<code><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#context">context</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkConnector.html#SinkConnector()">SinkConnector</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.connect.connector.Connector"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.connect.connector.<a href="../../../../../org/apache/kafka/connect/connector/Connector.html" title="class in org.apache.kafka.connect.connector">Connector</a></h3> +<code><a href="../../../../../org/apache/kafka/connect/connector/Connector.html#config()">config</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext)">initialize</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#initialize(org.apache.kafka.connect.connector.ConnectorContext,%20java.util.List)">initialize</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#reconfigure(java.util.Map)">reconfigure</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#start(java.util.Map)">start</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#stop()">stop</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#taskClass()">taskClass</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#taskConfigs(int)">taskConfigs</a>, <a href="../../../../../org/apache/kaf ka/connect/connector/Connector.html#validate(java.util.Map)">validate</a>, <a href="../../../../../org/apache/kafka/connect/connector/Connector.html#version()">version</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="TOPICS_CONFIG"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TOPICS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> TOPICS_CONFIG</pre> +<div class="block"><p> + Configuration key for the list of input topics for this connector. + </p> + <p> + Usually this setting is only relevant to the Kafka Connect framework, but is provided here for + the convenience of Connector developers if they also need to know the set of topics. + </p></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.connect.sink.SinkConnector.TOPICS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SinkConnector()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SinkConnector</h4> +<pre>public SinkConnector()</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkConnector.html" target="_top">Frames</a></li> +<li><a href="SinkConnector.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_org.apache.kafka.connect.connector.Connector">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/SinkRecord.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/SinkRecord.html b/0100/javadoc/org/apache/kafka/connect/sink/SinkRecord.html new file mode 100644 index 0000000..6412c5e --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/SinkRecord.html @@ -0,0 +1,333 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:05 BST 2016 --> +<title>SinkRecord (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SinkRecord (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/kafka/connect/sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkRecord.html" target="_top">Frames</a></li> +<li><a href="SinkRecord.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.kafka.connect.sink</div> +<h2 title="Class SinkRecord" class="title">Class SinkRecord</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">org.apache.kafka.connect.connector.ConnectRecord</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.connect.sink.SinkRecord</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public class <span class="strong">SinkRecord</span> +extends <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">ConnectRecord</a></pre> +<div class="block">SinkRecord is a <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector"><code>ConnectRecord</code></a> that has been read from Kafka and includes the kafkaOffset of + the record in the Kafka topic-partition in addition to the standard fields. This information + should be used by the SinkTask to coordinate kafkaOffset commits.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html#SinkRecord(java.lang.String,%20int,%20org.apache.kafka.connect.data.Schema,%20java.lang.Object,%20org.apache.kafka.connect.data.Schema,%20java.lang.Object,%20long)">SinkRecord</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + long kafkaOffset)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html#kafkaOffset()">kafkaOffset</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.connect.connector.ConnectRecord"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.connect.connector.<a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">ConnectRecord</a></h3> +<code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#kafkaPartition()">kafkaPartition</a>, <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#key()">key</a>, <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#keySchema()">keySchema</a>, <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#topic()">topic</a>, <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#value()">value</a>, <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#valueSchema()">valueSchema</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SinkRecord(java.lang.String, int, org.apache.kafka.connect.data.Schema, java.lang.Object, org.apache.kafka.connect.data.Schema, java.lang.Object, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SinkRecord</h4> +<pre>public SinkRecord(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key, + <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + long kafkaOffset)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="kafkaOffset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>kafkaOffset</h4> +<pre>public long kafkaOffset()</pre> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">ConnectRecord</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">ConnectRecord</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html#toString()">toString</a></code> in class <code><a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector">ConnectRecord</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/kafka/connect/sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkRecord.html" target="_top">Frames</a></li> +<li><a href="SinkRecord.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/SinkTask.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/SinkTask.html b/0100/javadoc/org/apache/kafka/connect/sink/SinkTask.html new file mode 100644 index 0000000..4b73691 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/SinkTask.html @@ -0,0 +1,521 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:05 BST 2016 --> +<title>SinkTask (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SinkTask (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkTask.html" target="_top">Frames</a></li> +<li><a href="SinkTask.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </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="subNavList"> +<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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.connect.sink</div> +<h2 title="Class SinkTask" class="title">Class SinkTask</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.connect.sink.SinkTask</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public abstract class <span class="strong">SinkTask</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></pre> +<div class="block">SinkTask is a Task that takes records loaded from Kafka and sends them to another system. Each task + instance is assigned a set of partitions by the Connect framework and will handle all records received + from those partitions. As records are fetched from Kafka, they will be passed to the sink task using the + <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(Collection)</code></a> API, which should either write them to the downstream system or batch them for + later writing. Periodically, Connect will call <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#flush(java.util.Map)"><code>flush(Map)</code></a> to ensure that batched records are + actually pushed to the downstream system.. + + Below we describe the lifecycle of a SinkTask. + + <ol> + <li><b>Initialization:</b> SinkTasks are first initialized using <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#initialize(org.apache.kafka.connect.sink.SinkTaskContext)"><code>initialize(SinkTaskContext)</code></a> + to prepare the task's context and <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#start(java.util.Map)"><code>start(Map)</code></a> to accept configuration and start any services + needed for processing.</li> + <li><b>Partition Assignment:</b> After initialization, Connect will assign the task a set of partitions + using <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)"><code>open(Collection)</code></a>. These partitions are owned exclusively by this task until they + have been closed with <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#close(java.util.Collection)"><code>close(Collection)</code></a>.</li> + <li><b>Record Processing:</b> Once partitions have been opened for writing, Connect will begin forwarding + records from Kafka using the <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(Collection)</code></a> API. Periodically, Connect will ask the task + to flush records using <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#flush(java.util.Map)"><code>flush(Map)</code></a> as described above.</li> + <li><b>Partition Rebalancing:</b> Occasionally, Connect will need to change the assignment of this task. + When this happens, the currently assigned partitions will be closed with <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#close(java.util.Collection)"><code>close(Collection)</code></a> and + the new assignment will be opened using <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)"><code>open(Collection)</code></a>.</li> + <li><b>Shutdown:</b> When the task needs to be shutdown, Connect will close active partitions (if there + are any) and stop the task using <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#stop()"><code>stop()</code></a></li> + </ol></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </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>protected <a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink">SinkTaskContext</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#context">context</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#TOPICS_CONFIG">TOPICS_CONFIG</a></strong></code> +<div class="block"> + The configuration key that provides the list of topics that are inputs for this + SinkTask.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#SinkTask()">SinkTask</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#close(java.util.Collection)">close</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block">The SinkTask use this method to close writers for partitions that are no + longer assigned to the SinkTask.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#flush(java.util.Map)">flush</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../../org/apache/kafka/clients/consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets)</code> +<div class="block">Flush all records that have been <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(java.util.Collection<org.apache.kafka.connect.sink.SinkRecord>)</code></a> for the specified topic-partitions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#initialize(org.apache.kafka.connect.sink.SinkTaskContext)">initialize</a></strong>(<a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink">SinkTaskContext</a> context)</code> +<div class="block">Initialize the context of this task.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#onPartitionsAssigned(java.util.Collection)">onPartitionsAssigned</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Use <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)"><code>open(Collection)</code></a> for partition initialization.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#onPartitionsRevoked(java.util.Collection)">onPartitionsRevoked</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Use <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#close(java.util.Collection)"><code>close(Collection)</code></a> instead for partition cleanup.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)">open</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</code> +<div class="block">The SinkTask use this method to create writers for newly assigned partitions in case of partition + rebalance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)">put</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink">SinkRecord</a>> records)</code> +<div class="block">Put the records in the sink.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#start(java.util.Map)">start</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</code> +<div class="block">Start the Task.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#stop()">stop</a></strong>()</code> +<div class="block">Perform any cleanup to stop this task.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.connect.connector.Task"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.kafka.connect.connector.<a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></h3> +<code><a href="../../../../../org/apache/kafka/connect/connector/Task.html#version()">version</a></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="TOPICS_CONFIG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TOPICS_CONFIG</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> TOPICS_CONFIG</pre> +<div class="block"><p> + The configuration key that provides the list of topics that are inputs for this + SinkTask. + </p></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.kafka.connect.sink.SinkTask.TOPICS_CONFIG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="context"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>context</h4> +<pre>protected <a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink">SinkTaskContext</a> context</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SinkTask()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SinkTask</h4> +<pre>public SinkTask()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initialize(org.apache.kafka.connect.sink.SinkTaskContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(<a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink">SinkTaskContext</a> context)</pre> +<div class="block">Initialize the context of this task. Note that the partition assignment will be empty until + Connect has opened the partitions for writing with <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)"><code>open(Collection)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - The sink task's context</dd></dl> +</li> +</ul> +<a name="start(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public abstract void start(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> props)</pre> +<div class="block">Start the Task. This should handle any configuration parsing and one-time setup of the task.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/connect/connector/Task.html#start(java.util.Map)">start</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - initial configuration</dd></dl> +</li> +</ul> +<a name="put(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public abstract void put(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink">SinkRecord</a>> records)</pre> +<div class="block">Put the records in the sink. Usually this should send the records to the sink asynchronously + and immediately return. + + If this operation fails, the SinkTask may throw a <a href="../../../../../org/apache/kafka/connect/errors/RetriableException.html" title="class in org.apache.kafka.connect.errors"><code>RetriableException</code></a> to + indicate that the framework should attempt to retry the same call again. Other exceptions will cause the task to + be stopped immediately. <a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#timeout(long)"><code>SinkTaskContext.timeout(long)</code></a> can be used to set the maximum time before the + batch will be retried.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>records</code> - the set of records to send</dd></dl> +</li> +</ul> +<a name="flush(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>public abstract void flush(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="../../../../../org/apache/kafka/clients/consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets)</pre> +<div class="block">Flush all records that have been <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(java.util.Collection<org.apache.kafka.connect.sink.SinkRecord>)</code></a> for the specified topic-partitions. The + offsets are provided for convenience, but could also be determined by tracking all offsets + included in the SinkRecords passed to <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(java.util.Collection<org.apache.kafka.connect.sink.SinkRecord>)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsets</code> - mapping of TopicPartition to committed offset</dd></dl> +</li> +</ul> +<a name="open(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>open</h4> +<pre>public void open(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block">The SinkTask use this method to create writers for newly assigned partitions in case of partition + rebalance. This method will be called after partition re-assignment completes and before the SinkTask starts + fetching data. Note that any errors raised from this method will cause the task to stop.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - The list of partitions that are now assigned to the task (may include + partitions previously assigned to the task)</dd></dl> +</li> +</ul> +<a name="onPartitionsAssigned(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPartitionsAssigned</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void onPartitionsAssigned(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Use <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#open(java.util.Collection)"><code>open(Collection)</code></a> for partition initialization.</i></div> +</li> +</ul> +<a name="close(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block">The SinkTask use this method to close writers for partitions that are no + longer assigned to the SinkTask. This method will be called before a rebalance operation starts + and after the SinkTask stops fetching data. After being closed, Connect will not write + any records to the task until a new set of partitions has been opened. Note that any errors raised + from this method will cause the task to stop.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - The list of partitions that should be closed</dd></dl> +</li> +</ul> +<a name="onPartitionsRevoked(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPartitionsRevoked</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void onPartitionsRevoked(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Use <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#close(java.util.Collection)"><code>close(Collection)</code></a> instead for partition cleanup.</i></div> +</li> +</ul> +<a name="stop()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public abstract void stop()</pre> +<div class="block">Perform any cleanup to stop this task. In SinkTasks, this method is invoked only once outstanding calls to other + methods have completed (e.g., <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#put(java.util.Collection)"><code>put(Collection)</code></a> has returned) and a final <a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html#flush(java.util.Map)"><code>flush(Map)</code></a> and offset + commit has completed. Implementations of this method should only need to perform final cleanup operations, such + as closing network connections to the sink system.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/connect/connector/Task.html#stop()">stop</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/connector/Task.html" title="interface in org.apache.kafka.connect.connector">Task</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkTask.html" target="_top">Frames</a></li> +<li><a href="SinkTask.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </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="subNavList"> +<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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/SinkTaskContext.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/SinkTaskContext.html b/0100/javadoc/org/apache/kafka/connect/sink/SinkTaskContext.html new file mode 100644 index 0000000..283afec --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/SinkTaskContext.html @@ -0,0 +1,310 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:05 BST 2016 --> +<title>SinkTaskContext (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SinkTaskContext (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/kafka/connect/sink/SinkTask.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkTaskContext.html" target="_top">Frames</a></li> +<li><a href="SinkTaskContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.kafka.connect.sink</div> +<h2 title="Interface SinkTaskContext" class="title">Interface SinkTaskContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceStability.Unstable +public interface <span class="strong">SinkTaskContext</span></pre> +<div class="block">Context passed to SinkTasks, allowing them to access utilities in the Kafka Connect runtime.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#assignment()">assignment</a></strong>()</code> +<div class="block">Get the current set of assigned TopicPartitions for this task.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#offset(java.util.Map)">offset</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> offsets)</code> +<div class="block">Reset the consumer offsets for the given topic partitions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#offset(org.apache.kafka.common.TopicPartition,%20long)">offset</a></strong>(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> tp, + long offset)</code> +<div class="block">Reset the consumer offsets for the given topic partition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#pause(org.apache.kafka.common.TopicPartition...)">pause</a></strong>(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>... partitions)</code> +<div class="block">Pause consumption of messages from the specified TopicPartitions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#resume(org.apache.kafka.common.TopicPartition...)">resume</a></strong>(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>... partitions)</code> +<div class="block">Resume consumption of messages from previously paused TopicPartitions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html#timeout(long)">timeout</a></strong>(long timeoutMs)</code> +<div class="block">Set the timeout in milliseconds.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="offset(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>void offset(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> offsets)</pre> +<div class="block">Reset the consumer offsets for the given topic partitions. SinkTasks should use this if they manage offsets + in the sink data store rather than using Kafka consumer offsets. For example, an HDFS connector might record + offsets in HDFS to provide exactly once delivery. When the SinkTask is started or a rebalance occurs, the task + would reload offsets from HDFS and use this method to reset the consumer to those offsets. + + SinkTasks that do not manage their own offsets do not need to use this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsets</code> - map of offsets for topic partitions</dd></dl> +</li> +</ul> +<a name="offset(org.apache.kafka.common.TopicPartition, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>void offset(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a> tp, + long offset)</pre> +<div class="block">Reset the consumer offsets for the given topic partition. SinkTasks should use if they manage offsets + in the sink data store rather than using Kafka consumer offsets. For example, an HDFS connector might record + offsets in HDFS to provide exactly once delivery. When the topic partition is recovered the task + would reload offsets from HDFS and use this method to reset the consumer to the offset. + + SinkTasks that do not manage their own offsets do not need to use this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tp</code> - the topic partition to reset offset.</dd><dd><code>offset</code> - the offset to reset to.</dd></dl> +</li> +</ul> +<a name="timeout(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timeout</h4> +<pre>void timeout(long timeoutMs)</pre> +<div class="block">Set the timeout in milliseconds. SinkTasks should use this to indicate that they need to retry certain + operations after the timeout. SinkTasks may have certain operations on external systems that may need + to retry in case of failures. For example, append a record to an HDFS file may fail due to temporary network + issues. SinkTasks use this method to set how long to wait before retrying.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - the backoff timeout in milliseconds.</dd></dl> +</li> +</ul> +<a name="assignment()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>assignment</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> assignment()</pre> +<div class="block">Get the current set of assigned TopicPartitions for this task.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the set of currently assigned TopicPartitions</dd></dl> +</li> +</ul> +<a name="pause(org.apache.kafka.common.TopicPartition...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pause</h4> +<pre>void pause(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>... partitions)</pre> +<div class="block">Pause consumption of messages from the specified TopicPartitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - the partitions which should be paused</dd></dl> +</li> +</ul> +<a name="resume(org.apache.kafka.common.TopicPartition...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>resume</h4> +<pre>void resume(<a href="../../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>... partitions)</pre> +<div class="block">Resume consumption of messages from previously paused TopicPartitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partitions</code> - the partitions to resume</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/kafka/connect/sink/SinkTask.html" title="class in org.apache.kafka.connect.sink"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/SinkTaskContext.html" target="_top">Frames</a></li> +<li><a href="SinkTaskContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/package-frame.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/package-frame.html b/0100/javadoc/org/apache/kafka/connect/sink/package-frame.html new file mode 100644 index 0000000..e224632 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/package-frame.html @@ -0,0 +1,25 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:06 BST 2016 --> +<title>org.apache.kafka.connect.sink (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/kafka/connect/sink/package-summary.html" target="classFrame">org.apache.kafka.connect.sink</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink" target="classFrame"><i>SinkTaskContext</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="SinkConnector.html" title="class in org.apache.kafka.connect.sink" target="classFrame">SinkConnector</a></li> +<li><a href="SinkRecord.html" title="class in org.apache.kafka.connect.sink" target="classFrame">SinkRecord</a></li> +<li><a href="SinkTask.html" title="class in org.apache.kafka.connect.sink" target="classFrame">SinkTask</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/connect/sink/package-summary.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/connect/sink/package-summary.html b/0100/javadoc/org/apache/kafka/connect/sink/package-summary.html new file mode 100644 index 0000000..1619d38 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/connect/sink/package-summary.html @@ -0,0 +1,163 @@ +<!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 (version 1.7.0_80) on Thu May 19 00:52:06 BST 2016 --> +<title>org.apache.kafka.connect.sink (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.kafka.connect.sink (kafka 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>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/kafka/connect/errors/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/connect/source/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.kafka.connect.sink</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/connect/sink/SinkTaskContext.html" title="interface in org.apache.kafka.connect.sink">SinkTaskContext</a></td> +<td class="colLast"> +<div class="block">Context passed to SinkTasks, allowing them to access utilities in the Kafka Connect runtime.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/connect/sink/SinkConnector.html" title="class in org.apache.kafka.connect.sink">SinkConnector</a></td> +<td class="colLast"> +<div class="block">SinkConnectors implement the Connector interface to send Kafka data to another system.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/connect/sink/SinkRecord.html" title="class in org.apache.kafka.connect.sink">SinkRecord</a></td> +<td class="colLast"> +<div class="block">SinkRecord is a <a href="../../../../../org/apache/kafka/connect/connector/ConnectRecord.html" title="class in org.apache.kafka.connect.connector"><code>ConnectRecord</code></a> that has been read from Kafka and includes the kafkaOffset of + the record in the Kafka topic-partition in addition to the standard fields.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/connect/sink/SinkTask.html" title="class in org.apache.kafka.connect.sink">SinkTask</a></td> +<td class="colLast"> +<div class="block">SinkTask is a Task that takes records loaded from Kafka and sends them to another system.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>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/kafka/connect/errors/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/connect/source/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/connect/sink/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
