blob: 3bfddeedfb192f1dc11df879379dd086769c1d88 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Tue Apr 25 03:06:36 SST 2017 -->
<title>KafkaSink</title>
<meta name="date" content="2017-04-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KafkaSink";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/gearpump/streaming/kafka/KafkaSource.html" title="class in org.apache.gearpump.streaming.kafka"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/kafka/KafkaSink.html" target="_top">Frames</a></li>
<li><a href="KafkaSink.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.gearpump.streaming.kafka</div>
<h2 title="Class KafkaSink" class="title">Class KafkaSink</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html" title="class in org.apache.gearpump.streaming.kafka.lib.sink">org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink</a></li>
<li>
<ul class="inheritance">
<li>org.apache.gearpump.streaming.kafka.KafkaSink</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html" title="interface in org.apache.gearpump.streaming.sink">DataSink</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">KafkaSink</span>
extends <a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html" title="class in org.apache.gearpump.streaming.kafka.lib.sink">AbstractKafkaSink</a>
implements <a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html" title="interface in org.apache.gearpump.streaming.sink">DataSink</a></pre>
<div class="block">USER API for kafka sink connector.
Please refer to <a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html" title="class in org.apache.gearpump.streaming.kafka.lib.sink"><code>AbstractKafkaSink</code></a> for detailed descriptions and implementations.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.gearpump.streaming.kafka.KafkaSink">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.gearpump.streaming.kafka.lib.sink.<a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html" title="class in org.apache.gearpump.streaming.kafka.lib.sink">AbstractKafkaSink</a></h3>
<code><a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.KafkaProducerFactory.html" title="interface in org.apache.gearpump.streaming.kafka.lib.sink">AbstractKafkaSink.KafkaProducerFactory</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/kafka/KafkaSink.html#KafkaSink-java.lang.String-java.util.Properties-">KafkaSink</a></span>(java.lang.String&nbsp;topic,
java.util.Properties&nbsp;props)</code>&nbsp;</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.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.gearpump.streaming.kafka.lib.sink.<a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html" title="class in org.apache.gearpump.streaming.kafka.lib.sink">AbstractKafkaSink</a></h3>
<code><a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html#close--">close</a>, <a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html#open-org.apache.gearpump.streaming.task.TaskContext-">open</a>, <a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html#producerFactory--">producerFactory</a>, <a href="../../../../../org/apache/gearpump/streaming/kafka/lib/sink/AbstractKafkaSink.html#write-org.apache.gearpump.Message-">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.gearpump.streaming.sink.DataSink">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.gearpump.streaming.sink.<a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html" title="interface in org.apache.gearpump.streaming.sink">DataSink</a></h3>
<code><a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html#close--">close</a>, <a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html#open-org.apache.gearpump.streaming.task.TaskContext-">open</a>, <a href="../../../../../org/apache/gearpump/streaming/sink/DataSink.html#write-org.apache.gearpump.Message-">write</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="KafkaSink-java.lang.String-java.util.Properties-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KafkaSink</h4>
<pre>public&nbsp;KafkaSink(java.lang.String&nbsp;topic,
java.util.Properties&nbsp;props)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/gearpump/streaming/kafka/KafkaSource.html" title="class in org.apache.gearpump.streaming.kafka"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/kafka/KafkaSink.html" target="_top">Frames</a></li>
<li><a href="KafkaSink.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.gearpump.streaming.kafka.lib.sink.AbstractKafkaSink">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>