blob: e0f7b1b60c7103c1ad127a03fbe778cd854011f7 [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_40) on Thu Jul 20 13:16:31 PDT 2017 -->
<title>gobblin.source.extractor.extract.kafka (gobblin-kafka-common 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="gobblin.source.extractor.extract.kafka (gobblin-kafka-common 0.11.0 API)";
}
}
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 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="../../../../../gobblin/metrics/reporter/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../gobblin/source/extractor/extract/kafka/workunit/packer/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/source/extractor/extract/kafka/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;gobblin.source.extractor.extract.kafka</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" 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="../../../../../gobblin/source/extractor/extract/kafka/ConfigStoreUtils.html" title="class in gobblin.source.extractor.extract.kafka">ConfigStoreUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/ConfluentKafkaSchemaRegistry.html" title="class in gobblin.source.extractor.extract.kafka">ConfluentKafkaSchemaRegistry</a></td>
<td class="colLast">
<div class="block">Extension of <a href="../../../../../gobblin/metrics/kafka/KafkaSchemaRegistry.html" title="class in gobblin.metrics.kafka"><code>KafkaSchemaRegistry</code></a> that wraps Confluent's <code>SchemaRegistryClient</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/FixedSchemaKafkaAvroExtractor.html" title="class in gobblin.source.extractor.extract.kafka">FixedSchemaKafkaAvroExtractor</a></td>
<td class="colLast">
<div class="block">Extract avro records from a Kafka topic using a fixed schema provided by <a href="../../../../../gobblin/source/extractor/extract/kafka/FixedSchemaKafkaAvroExtractor.html#STATIC_SCHEMA_ROOT_KEY"><code>FixedSchemaKafkaAvroExtractor.STATIC_SCHEMA_ROOT_KEY</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaAvroExtractor.html" title="class in gobblin.source.extractor.extract.kafka">KafkaAvroExtractor</a>&lt;K&gt;</td>
<td class="colLast">
<div class="block">An abstract implementation of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/Extractor.html?is-external=true" title="class or interface in gobblin.source.extractor"><code>Extractor</code></a> for Kafka, where events are in Avro format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaExtractor.html" title="class in gobblin.source.extractor.extract.kafka">KafkaExtractor</a>&lt;S,D&gt;</td>
<td class="colLast">
<div class="block">An implementation of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/Extractor.html?is-external=true" title="class or interface in gobblin.source.extractor"><code>Extractor</code></a> for Apache Kafka.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaPartition.html" title="class in gobblin.source.extractor.extract.kafka">KafkaPartition</a></td>
<td class="colLast">
<div class="block">A kafka topic partition.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaPartition.Builder.html" title="class in gobblin.source.extractor.extract.kafka">KafkaPartition.Builder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaPartition.KafkaLeader.html" title="class in gobblin.source.extractor.extract.kafka">KafkaPartition.KafkaLeader</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaRecord.html" title="class in gobblin.source.extractor.extract.kafka">KafkaRecord</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaSimpleExtractor.html" title="class in gobblin.source.extractor.extract.kafka">KafkaSimpleExtractor</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">use <code>KafkaDeserializerExtractor</code> and <code>KafkaDeserializerExtractor.Deserializers#BYTE_ARRAY</code> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaSimpleJsonExtractor.html" title="class in gobblin.source.extractor.extract.kafka">KafkaSimpleJsonExtractor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaSimpleSource.html" title="class in gobblin.source.extractor.extract.kafka">KafkaSimpleSource</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">use <code>KafkaDeserializerSource</code> and <code>KafkaDeserializerExtractor.Deserializers#BYTE_ARRAY</code> instead</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaSource.html" title="class in gobblin.source.extractor.extract.kafka">KafkaSource</a>&lt;S,D&gt;</td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/Source.html?is-external=true" title="class or interface in gobblin.source"><code>Source</code></a> implementation for Kafka source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaTopic.html" title="class in gobblin.source.extractor.extract.kafka">KafkaTopic</a></td>
<td class="colLast">
<div class="block">A kafka topic is composed of a topic name, and a list of partitions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaUtils.html" title="class in gobblin.source.extractor.extract.kafka">KafkaUtils</a></td>
<td class="colLast">
<div class="block">A Utils class for Kafka.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/MultiLongWatermark.html" title="class in gobblin.source.extractor.extract.kafka">MultiLongWatermark</a></td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/Watermark.html?is-external=true" title="class or interface in gobblin.source.extractor"><code>Watermark</code></a> that holds multiple long values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/SimpleKafkaSchemaRegistry.html" title="class in gobblin.source.extractor.extract.kafka">SimpleKafkaSchemaRegistry</a></td>
<td class="colLast">
<div class="block">Extension of <a href="../../../../../gobblin/metrics/kafka/KafkaSchemaRegistry.html" title="class in gobblin.metrics.kafka"><code>KafkaSchemaRegistry</code></a> that treats the topic name and the schema as the same string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/UniversalKafkaSource.html" title="class in gobblin.source.extractor.extract.kafka">UniversalKafkaSource</a>&lt;S,D&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaSource.html" title="class in gobblin.source.extractor.extract.kafka"><code>KafkaSource</code></a> to use with arbitrary <a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaExtractor.html" title="class in gobblin.source.extractor.extract.kafka"><code>KafkaExtractor</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/KafkaOffsetRetrievalFailureException.html" title="class in gobblin.source.extractor.extract.kafka">KafkaOffsetRetrievalFailureException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/PreviousOffsetNotFoundException.html" title="class in gobblin.source.extractor.extract.kafka">PreviousOffsetNotFoundException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../gobblin/source/extractor/extract/kafka/StartOffsetOutOfRangeException.html" title="class in gobblin.source.extractor.extract.kafka">StartOffsetOutOfRangeException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 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="../../../../../gobblin/metrics/reporter/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../gobblin/source/extractor/extract/kafka/workunit/packer/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?gobblin/source/extractor/extract/kafka/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>