blob: 07d2be45c8fce7d5d5ac84b9dc626b0c72ddf9b5 [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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.twill.kafka.client (Apache Twill 0.6.0-incubating API)</title>
<meta name="date" content="2015-07-24">
<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.twill.kafka.client (Apache Twill 0.6.0-incubating 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-use.html">Use</a></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/twill/filesystem/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/twill/launcher/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/twill/kafka/client/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&nbsp;org.apache.twill.kafka.client</h1>
<div class="docSummary">
<div class="block">This package provides Kafka client interfaces.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</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">&nbsp;</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/twill/kafka/client/BrokerService.html" title="interface in org.apache.twill.kafka.client">BrokerService</a></td>
<td class="colLast">
<div class="block">Service for providing information of kafka brokers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client">FetchedMessage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client">KafkaClient</a></td>
<td class="colLast">
<div class="block">Represents a kafka client that can publish/subscribe to a Kafka server cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client">KafkaClientService</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client"><code>KafkaClient</code></a> that extends <code>Service</code> to provide lifecycle management.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer</a></td>
<td class="colLast">
<div class="block">A consumer for consuming (reading) messages published to a Kafka server cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.MessageCallback</a></td>
<td class="colLast">
<div class="block">Callback for receiving new messages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></td>
<td class="colLast">
<div class="block">A builder for preparing message consumption.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher</a></td>
<td class="colLast">
<div class="block">This interface is for publishing data to Kafka.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher.Preparer</a></td>
<td class="colLast">
<div class="block">A Preparer for preparing to publish messages to a given topic.</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">&nbsp;</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/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a></td>
<td class="colLast">
<div class="block">Represents broker information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a></td>
<td class="colLast">
<div class="block">Listener for changes in broker list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/TopicPartition.html" title="class in org.apache.twill.kafka.client">TopicPartition</a></td>
<td class="colLast">
<div class="block">Represents a combination of topic and partition.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/Compression.html" title="enum in org.apache.twill.kafka.client">Compression</a></td>
<td class="colLast">
<div class="block">An Enum representing different compression codec options for publishing messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a></td>
<td class="colLast">
<div class="block">Represents the desired level of publish acknowledgment.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.apache.twill.kafka.client Description">Package org.apache.twill.kafka.client Description</h2>
<div class="block">This package provides Kafka client interfaces.</div>
</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-use.html">Use</a></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/twill/filesystem/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/twill/launcher/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/twill/kafka/client/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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>