Google Git
Sign in
apache / streams / refs/heads/asf-site / . / streams-contrib / streams-amazon-aws / streams-persist-s3 / apidocs / serialized-form.html
blob: c187b2d148a781b36c42165fb937248ede4e8cbb [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_152) on Mon Apr 02 22:48:32 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Serialized Form (streams-persist-s3 0.5.2-SNAPSHOT API)</title>
<meta name="date" content="2018-04-02">
<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="Serialized Form (streams-persist-s3 0.5.2-SNAPSHOT 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="org/apache/streams/s3/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/streams/s3/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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.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="Serialized Form" class="title">Serialized Form</h1>
</div>
<div class="serializedFormContainer">
<ul class="blockList">
<li class="blockList">
<h2 title="Package">Package&nbsp;org.apache.streams.s3</h2>
<ul class="blockList">
<li class="blockList"><a name="org.apache.streams.s3.S3Configuration">
<!-- -->
</a>
<h3>Class <a href="org/apache/streams/s3/S3Configuration.html" title="class in org.apache.streams.s3">org.apache.streams.s3.S3Configuration</a> extends <a href="https://github.com/apache/streams/streams-components/streams-converters/apidocs/org/apache/streams/converter/LineReadWriteConfiguration.html?is-external=true" title="class or interface in org.apache.streams.converter">LineReadWriteConfiguration</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>key</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key</pre>
<div class="block">Your Amazon Key
(Required)</div>
</li>
<li class="blockList">
<h4>secretKey</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> secretKey</pre>
<div class="block">Your Amazon Secret Key
(Required)</div>
</li>
<li class="blockList">
<h4>bucket</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bucket</pre>
<div class="block">Your AWS bucket
(Required)</div>
</li>
<li class="blockList">
<h4>protocol</h4>
<pre><a href="org/apache/streams/s3/S3Configuration.Protocol.html" title="enum in org.apache.streams.s3">S3Configuration.Protocol</a> protocol</pre>
<div class="block">Whether you are using HTTP or HTTPS</div>
</li>
<li class="blockList">
<h4>region</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> region</pre>
<div class="block">The AWS region where your bucket resides</div>
</li>
<li class="blockListLast">
<h4>additionalProperties</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">K</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">V</a>&gt; additionalProperties</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.apache.streams.s3.S3PersistReader">
<!-- -->
</a>
<h3>Class <a href="org/apache/streams/s3/S3PersistReader.html" title="class in org.apache.streams.s3">org.apache.streams.s3.S3PersistReader</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>s3ReaderConfiguration</h4>
<pre><a href="org/apache/streams/s3/S3ReaderConfiguration.html" title="class in org.apache.streams.s3">S3ReaderConfiguration</a> s3ReaderConfiguration</pre>
</li>
<li class="blockList">
<h4>amazonS3Client</h4>
<pre>com.amazonaws.services.s3.AmazonS3Client amazonS3Client</pre>
</li>
<li class="blockList">
<h4>mapper</h4>
<pre>com.fasterxml.jackson.databind.ObjectMapper mapper</pre>
</li>
<li class="blockList">
<h4>lineReaderUtil</h4>
<pre><a href="https://github.com/apache/streams/streams-components/streams-converters/apidocs/org/apache/streams/converter/LineReadWriteUtil.html?is-external=true" title="class or interface in org.apache.streams.converter">LineReadWriteUtil</a> lineReaderUtil</pre>
</li>
<li class="blockList">
<h4>files</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">E</a>&gt; files</pre>
</li>
<li class="blockList">
<h4>executor</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> executor</pre>
</li>
<li class="blockList">
<h4>persistQueue</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">E</a>&gt; persistQueue</pre>
</li>
<li class="blockList">
<h4>countersTotal</h4>
<pre><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/DatumStatusCounter.html?is-external=true" title="class or interface in org.apache.streams.core">DatumStatusCounter</a> countersTotal</pre>
</li>
<li class="blockList">
<h4>countersCurrent</h4>
<pre><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/DatumStatusCounter.html?is-external=true" title="class or interface in org.apache.streams.core">DatumStatusCounter</a> countersCurrent</pre>
</li>
<li class="blockListLast">
<h4>task</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">V</a>&gt; task</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.apache.streams.s3.S3PersistWriter">
<!-- -->
</a>
<h3>Class <a href="org/apache/streams/s3/S3PersistWriter.html" title="class in org.apache.streams.s3">org.apache.streams.s3.S3PersistWriter</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>objectMapper</h4>
<pre>com.fasterxml.jackson.databind.ObjectMapper objectMapper</pre>
</li>
<li class="blockList">
<h4>amazonS3Client</h4>
<pre>com.amazonaws.services.s3.AmazonS3Client amazonS3Client</pre>
</li>
<li class="blockList">
<h4>s3WriterConfiguration</h4>
<pre><a href="org/apache/streams/s3/S3WriterConfiguration.html" title="class in org.apache.streams.s3">S3WriterConfiguration</a> s3WriterConfiguration</pre>
</li>
<li class="blockList">
<h4>writtenFiles</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">E</a>&gt; writtenFiles</pre>
</li>
<li class="blockList">
<h4>lineWriterUtil</h4>
<pre><a href="https://github.com/apache/streams/streams-components/streams-converters/apidocs/org/apache/streams/converter/LineReadWriteUtil.html?is-external=true" title="class or interface in org.apache.streams.converter">LineReadWriteUtil</a> lineWriterUtil</pre>
</li>
<li class="blockList">
<h4>totalBytesWritten</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicLong.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicLong</a> totalBytesWritten</pre>
</li>
<li class="blockList">
<h4>bytesWrittenThisFile</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicLong.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicLong</a> bytesWrittenThisFile</pre>
</li>
<li class="blockList">
<h4>totalRecordsWritten</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> totalRecordsWritten</pre>
</li>
<li class="blockList">
<h4>fileLineCounter</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> fileLineCounter</pre>
</li>
<li class="blockListLast">
<h4>currentWriter</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/io/OutputStreamWriter.html?is-external=true" title="class or interface in java.io">OutputStreamWriter</a> currentWriter</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.apache.streams.s3.S3ReaderConfiguration">
<!-- -->
</a>
<h3>Class <a href="org/apache/streams/s3/S3ReaderConfiguration.html" title="class in org.apache.streams.s3">org.apache.streams.s3.S3ReaderConfiguration</a> extends <a href="org/apache/streams/s3/S3Configuration.html" title="class in org.apache.streams.s3">S3Configuration</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>readerPath</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> readerPath</pre>
<div class="block">Path below root path</div>
</li>
<li class="blockListLast">
<h4>additionalProperties</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">K</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">V</a>&gt; additionalProperties</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="org.apache.streams.s3.S3WriterConfiguration">
<!-- -->
</a>
<h3>Class <a href="org/apache/streams/s3/S3WriterConfiguration.html" title="class in org.apache.streams.s3">org.apache.streams.s3.S3WriterConfiguration</a> extends <a href="org/apache/streams/s3/S3Configuration.html" title="class in org.apache.streams.s3">S3Configuration</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>writerPath</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writerPath</pre>
<div class="block">Path</div>
</li>
<li class="blockList">
<h4>writerFilePrefix</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writerFilePrefix</pre>
<div class="block">File Prefix</div>
</li>
<li class="blockList">
<h4>maxFileSize</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> maxFileSize</pre>
<div class="block">If files are elected to be 'chunked' which they are by default, this is the maximum size of that file before the byte array stream is vacated and the file is created.</div>
</li>
<li class="blockList">
<h4>chunk</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> chunk</pre>
<div class="block">Whether you want the file chunked inside of a folder or not</div>
</li>
<li class="blockList">
<h4>compression</h4>
<pre><a href="org/apache/streams/s3/S3WriterConfiguration.Compression.html" title="enum in org.apache.streams.s3">S3WriterConfiguration.Compression</a> compression</pre>
<div class="block">compression</div>
</li>
<li class="blockListLast">
<h4>additionalProperties</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">K</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">V</a>&gt; additionalProperties</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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="org/apache/streams/s3/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/streams/s3/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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?serialized-form.html" target="_top">Frames</a></li>
<li><a href="serialized-form.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>