blob: ac32bca5efc4fe982a068084e127c3ff2590acb2 [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:17:36 PDT 2017 -->
<title>gobblin.writer (gobblin-core 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.writer (gobblin-core 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/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../gobblin/writer/http/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/writer/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.writer</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" 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="../../gobblin/writer/MetadataAwareWriter.html" title="interface in gobblin.writer">MetadataAwareWriter</a></td>
<td class="colLast">
<div class="block">Represents a Writer that is metadata aware.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/Retriable.html" title="interface in gobblin.writer">Retriable</a></td>
<td class="colLast">
<div class="block">Interface that provides RetryerBuilder so that specific Retry logic can be injected.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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/writer/AbstractAsyncDataWriter.html" title="class in gobblin.writer">AbstractAsyncDataWriter</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">Base class to write data asynchronously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/AvroDataWriterBuilder.html" title="class in gobblin.writer">AvroDataWriterBuilder</a></td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriterBuilder</code></a> for building <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> that writes in Avro format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/AvroHdfsDataWriter.html" title="class in gobblin.writer">AvroHdfsDataWriter</a></td>
<td class="colLast">
<div class="block">An extension to <a href="../../gobblin/writer/FsDataWriter.html" title="class in gobblin.writer"><code>FsDataWriter</code></a> that writes in Avro format in the form of <a href="http://avro.apache.org/docs/1.8.1/api/java/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/ConsoleWriter.html" title="class in gobblin.writer">ConsoleWriter</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">A simple console writer that prints the record to stdout</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/ConsoleWriterBuilder.html" title="class in gobblin.writer">ConsoleWriterBuilder</a>&lt;D&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/DataWriterWrapperBuilder.html" title="class in gobblin.writer">DataWriterWrapperBuilder</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">The purpose of this class is to add more feature to DataWriter such as retry or throttle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/FsDataWriter.html" title="class in gobblin.writer">FsDataWriter</a>&lt;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/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> does the work of setting the output/staging dir
and creating the FileSystem instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/FsDataWriterBuilder.html" title="class in gobblin.writer">FsDataWriterBuilder</a>&lt;S,D&gt;</td>
<td class="colLast">
<div class="block">A abstract <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriterBuilder</code></a> for building <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a>s that write to
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/HiveWritableHdfsDataWriter.html" title="class in gobblin.writer">HiveWritableHdfsDataWriter</a></td>
<td class="colLast">
<div class="block">An extension to <a href="../../gobblin/writer/FsDataWriter.html" title="class in gobblin.writer"><code>FsDataWriter</code></a> that writes <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/io/Writable.html?is-external=true" title="class or interface in org.apache.hadoop.io"><code>Writable</code></a> records using an
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/mapred/OutputFormat.html?is-external=true" title="class or interface in org.apache.hadoop.mapred"><code>OutputFormat</code></a> that implements <a href="https://hive.apache.org/javadocs/r1.0.1/api/org/apache/hadoop/hive/ql/io/HiveOutputFormat.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.io"><code>HiveOutputFormat</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/HiveWritableHdfsDataWriterBuilder.html" title="class in gobblin.writer">HiveWritableHdfsDataWriterBuilder</a>&lt;S&gt;</td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriterBuilder</code></a> for building <a href="../../gobblin/writer/HiveWritableHdfsDataWriter.html" title="class in gobblin.writer"><code>HiveWritableHdfsDataWriter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/MetadataWriterWrapper.html" title="class in gobblin.writer">MetadataWriterWrapper</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">Wraps an existing <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> and makes it metadata aware.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/PartitionedDataWriter.html" title="class in gobblin.writer">PartitionedDataWriter</a>&lt;S,D&gt;</td>
<td class="colLast">
<div class="block"><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> that partitions data using a partitioner, instantiates appropriate writers, and sends records to
the chosen writer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/RetryWriter.html" title="class in gobblin.writer">RetryWriter</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">Retry writer follows decorator pattern that retries on inner writer's failure.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/SchemaBasedPartitionedDataWriterBuilder.html" title="class in gobblin.writer">SchemaBasedPartitionedDataWriterBuilder</a></td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriterBuilder</code></a> that uses name field of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true#schema" title="class or interface in gobblin.writer"><code>DataWriterBuilder.schema</code></a> in path name and overrides <a href="../../gobblin/writer/SchemaBasedPartitionedDataWriterBuilder.html#getSchema--"><code>SchemaBasedPartitionedDataWriterBuilder.getSchema()</code></a>
to use <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/PartitionAwareDataWriterBuilder.html?is-external=true#partition" title="class or interface in gobblin.writer"><code>PartitionAwareDataWriterBuilder.partition</code></a>
Must be used with <a href="../../gobblin/writer/partitioner/SchemaBasedWriterPartitioner.html" title="class in gobblin.writer.partitioner"><code>SchemaBasedWriterPartitioner</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/SimpleDataWriter.html" title="class in gobblin.writer">SimpleDataWriter</a></td>
<td class="colLast">
<div class="block">An implementation of <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> that writes bytes directly to HDFS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../gobblin/writer/SimpleDataWriterBuilder.html" title="class in gobblin.writer">SimpleDataWriterBuilder</a></td>
<td class="colLast">
<div class="block">A <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriterBuilder.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriterBuilder</code></a> for building <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/writer/DataWriter.html?is-external=true" title="class or interface in gobblin.writer"><code>DataWriter</code></a> that writes bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../gobblin/writer/ThrottleWriter.html" title="class in gobblin.writer">ThrottleWriter</a>&lt;D&gt;</td>
<td class="colLast">
<div class="block">Throttle writer follows decorator pattern that throttles inner writer by either QPS or by bytes.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" 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="../../gobblin/writer/ThrottleWriter.ThrottleType.html" title="enum in gobblin.writer">ThrottleWriter.ThrottleType</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/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../gobblin/writer/http/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/writer/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>