blob: dfe422b374406012c0640e577813d11784ce8696 [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 -->
<title>DynamicAvroDestinations (Apache Beam 2.38.0-SNAPSHOT)</title>
<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="DynamicAvroDestinations (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.ParamsCoder.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/io/DynamicFileDestinations.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/io/DynamicAvroDestinations.html" target="_top">Frames</a></li>
<li><a href="DynamicAvroDestinations.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">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><a href="#method.detail">Method</a></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.beam.sdk.io</div>
<h2 title="Class DynamicAvroDestinations" class="title">Class DynamicAvroDestinations&lt;UserT,DestinationT,OutputT&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.FileBasedSink.DynamicDestinations</a>&lt;UserT,DestinationT,OutputT&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.DynamicAvroDestinations&lt;UserT,DestinationT,OutputT&gt;</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/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">DynamicAvroDestinations&lt;UserT,DestinationT,OutputT&gt;</span>
extends <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">FileBasedSink.DynamicDestinations</a>&lt;UserT,DestinationT,OutputT&gt;</pre>
<div class="block">A specialization of <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.DynamicDestinations</code></a> for <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html" title="class in org.apache.beam.sdk.io"><code>AvroIO</code></a>. In addition to dynamic file
destinations, this allows specifying other AVRO properties (schema, metadata, codec, datum
writer) per destination.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.io.DynamicAvroDestinations">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/beam/sdk/io/DynamicAvroDestinations.html#DynamicAvroDestinations--">DynamicAvroDestinations</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/file/CodecFactory.html?is-external=true" title="class or interface in org.apache.avro.file">CodecFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html#getCodec-DestinationT-">getCodec</a></span>(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</code>
<div class="block">Return an AVRO codec for a given destination.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.io">AvroSink.DatumWriterFactory</a>&lt;<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">OutputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html#getDatumWriterFactory-DestinationT-">getDatumWriterFactory</a></span>(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destinationT)</code>
<div class="block">Return a <a href="../../../../../org/apache/beam/sdk/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.io"><code>AvroSink.DatumWriterFactory</code></a> for a given destination.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html#getMetadata-DestinationT-">getMetadata</a></span>(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</code>
<div class="block">Return AVRO file metadata for a given destination.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/Schema.html?is-external=true" title="class or interface in org.apache.avro">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html#getSchema-DestinationT-">getSchema</a></span>(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</code>
<div class="block">Return an AVRO schema for a given destination.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.FileBasedSink.DynamicDestinations">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.io.<a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">FileBasedSink.DynamicDestinations</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#formatRecord-UserT-">formatRecord</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#getDefaultDestination--">getDefaultDestination</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#getDestination-UserT-">getDestination</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#getDestinationCoder--">getDestinationCoder</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#getFilenamePolicy-DestinationT-">getFilenamePolicy</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#getSideInputs--">getSideInputs</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html#sideInput-org.apache.beam.sdk.values.PCollectionView-">sideInput</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>
</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="DynamicAvroDestinations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DynamicAvroDestinations</h4>
<pre>public&nbsp;DynamicAvroDestinations()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSchema-java.lang.Object-">
<!-- -->
</a><a name="getSchema-DestinationT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre>public abstract&nbsp;<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/Schema.html?is-external=true" title="class or interface in org.apache.avro">Schema</a>&nbsp;getSchema(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</pre>
<div class="block">Return an AVRO schema for a given destination.</div>
</li>
</ul>
<a name="getMetadata-java.lang.Object-">
<!-- -->
</a><a name="getMetadata-DestinationT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getMetadata(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</pre>
<div class="block">Return AVRO file metadata for a given destination.</div>
</li>
</ul>
<a name="getCodec-java.lang.Object-">
<!-- -->
</a><a name="getCodec-DestinationT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCodec</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/file/CodecFactory.html?is-external=true" title="class or interface in org.apache.avro.file">CodecFactory</a>&nbsp;getCodec(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destination)</pre>
<div class="block">Return an AVRO codec for a given destination.</div>
</li>
</ul>
<a name="getDatumWriterFactory-java.lang.Object-">
<!-- -->
</a><a name="getDatumWriterFactory-DestinationT-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDatumWriterFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.io">AvroSink.DatumWriterFactory</a>&lt;<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">OutputT</a>&gt;&nbsp;getDatumWriterFactory(<a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="type parameter in DynamicAvroDestinations">DestinationT</a>&nbsp;destinationT)</pre>
<div class="block">Return a <a href="../../../../../org/apache/beam/sdk/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.io"><code>AvroSink.DatumWriterFactory</code></a> for a given destination. If provided, it will be
used to created <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/DatumWriter.html?is-external=true" title="class or interface in org.apache.avro.io"><code>DatumWriter</code></a> instances as required.</div>
</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><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.ParamsCoder.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/io/DynamicFileDestinations.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/io/DynamicAvroDestinations.html" target="_top">Frames</a></li>
<li><a href="DynamicAvroDestinations.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">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><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>