blob: 3f41e24371816bbf500cd3182606e7dd22e11b22 [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>DynamicDestinations (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="DynamicDestinations (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":6,"i3":10,"i4":6,"i5":10};
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/gcp/bigquery/CreateTables.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/ErrorContainer.html" title="interface in org.apache.beam.sdk.io.gcp.bigquery"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" target="_top">Frames</a></li>
<li><a href="DynamicDestinations.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.gcp.bigquery</div>
<h2 title="Class DynamicDestinations" class="title">Class DynamicDestinations&lt;T,DestinationT&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.gcp.bigquery.DynamicDestinations&lt;T,DestinationT&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/StorageApiDynamicDestinationsTableRow.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">StorageApiDynamicDestinationsTableRow</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">DynamicDestinations&lt;T,DestinationT&gt;</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">This class provides the most general way of specifying dynamic BigQuery table destinations.
Destinations can be extracted from the input element, and stored as a custom type. Mappings are
provided to convert the destination into a BigQuery table reference and a BigQuery schema. The
class can read side inputs while performing these mappings.
<p>For example, consider a PCollection of events, each containing a user-id field. You want to
write each user's events to a separate table with a separate schema per user. Since the user-id
field is a string, you will represent the destination as a string.
<pre><code>
events.apply(BigQueryIO.&lt;UserEvent&gt;write()
.to(new DynamicDestinations&lt;UserEvent, String&gt;() {
public String getDestination(ValueInSingleWindow&lt;UserEvent&gt; element) {
return element.getValue().getUserId();
}
public TableDestination getTable(String user) {
return new TableDestination(tableForUser(user), "Table for user " + user);
}
public TableSchema getSchema(String user) {
return tableSchemaForUser(user);
}
})
.withFormatFunction(new SerializableFunction&lt;UserEvent, TableRow&gt;() {
public TableRow apply(UserEvent event) {
return convertUserEventToTableRow(event);
}
}));
</code></pre>
<p>An instance of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><code>DynamicDestinations</code></a> can also use side inputs using <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#sideInput-org.apache.beam.sdk.values.PCollectionView-"><code>sideInput(PCollectionView)</code></a>. The side inputs must be present in <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getSideInputs--"><code>getSideInputs()</code></a>. Side
inputs are accessed in the global window, so they must be globally windowed.
<p><code>DestinationT</code> is expected to provide proper hash and equality members. Ideally it will
be a compact type with an efficient coder, as these objects may be used as a key in a <a href="../../../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.gcp.bigquery.DynamicDestinations">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/gcp/bigquery/DynamicDestinations.html#DynamicDestinations--">DynamicDestinations</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>abstract <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getDestination-org.apache.beam.sdk.values.ValueInSingleWindow-">getDestination</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/ValueInSingleWindow.html" title="class in org.apache.beam.sdk.values">ValueInSingleWindow</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">T</a>&gt;&nbsp;element)</code>
<div class="block">Returns an object that represents at a high level which table is being written to.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getDestinationCoder--">getDestinationCoder</a></span>()</code>
<div class="block">Returns the coder for <code>DestinationT</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="https://static.javadoc.io/com.google.apis/google-api-services-bigquery/v2-rev20211129-1.32.1/com/google/api/services/bigquery/model/TableSchema.html?is-external=true" title="class or interface in com.google.api.services.bigquery.model">TableSchema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getSchema-DestinationT-">getSchema</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&nbsp;destination)</code>
<div class="block">Returns the table schema for the destination.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getSideInputs--">getSideInputs</a></span>()</code>
<div class="block">Specifies that this object needs access to one or more side inputs.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TableDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">TableDestination</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getTable-DestinationT-">getTable</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&nbsp;destination)</code>
<div class="block">Returns a <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TableDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><code>TableDestination</code></a> object for the destination.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected &lt;SideInputT&gt;<br>SideInputT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#sideInput-org.apache.beam.sdk.values.PCollectionView-">sideInput</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;SideInputT&gt;&nbsp;view)</code>
<div class="block">Returns the value of a given side input.</div>
</td>
</tr>
</table>
<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="DynamicDestinations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DynamicDestinations</h4>
<pre>public&nbsp;DynamicDestinations()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSideInputs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSideInputs</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;?&gt;&gt;&nbsp;getSideInputs()</pre>
<div class="block">Specifies that this object needs access to one or more side inputs. This side inputs must be
globally windowed, as they will be accessed from the global window.</div>
</li>
</ul>
<a name="sideInput-org.apache.beam.sdk.values.PCollectionView-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sideInput</h4>
<pre>protected final&nbsp;&lt;SideInputT&gt;&nbsp;SideInputT&nbsp;sideInput(<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;SideInputT&gt;&nbsp;view)</pre>
<div class="block">Returns the value of a given side input. The view must be present in <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html#getSideInputs--"><code>getSideInputs()</code></a>.</div>
</li>
</ul>
<a name="getDestination-org.apache.beam.sdk.values.ValueInSingleWindow-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDestination</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&nbsp;getDestination(<a href="../../../../../../../org/apache/beam/sdk/values/ValueInSingleWindow.html" title="class in org.apache.beam.sdk.values">ValueInSingleWindow</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">T</a>&gt;&nbsp;element)</pre>
<div class="block">Returns an object that represents at a high level which table is being written to. May not
return null.</div>
</li>
</ul>
<a name="getDestinationCoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDestinationCoder</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&gt;&nbsp;getDestinationCoder()</pre>
<div class="block">Returns the coder for <code>DestinationT</code>. If this is not overridden, then <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><code>BigQueryIO</code></a>
will look in the coder registry for a suitable coder. This must be a deterministic coder, as
<code>DestinationT</code> will be used as a key type in a <a href="../../../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a>.</div>
</li>
</ul>
<a name="getTable-java.lang.Object-">
<!-- -->
</a><a name="getTable-DestinationT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TableDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">TableDestination</a>&nbsp;getTable(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&nbsp;destination)</pre>
<div class="block">Returns a <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TableDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><code>TableDestination</code></a> object for the destination. May not return null. Return
value needs to be unique to each destination: may not return the same <a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/TableDestination.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><code>TableDestination</code></a>
for different destinations.</div>
</li>
</ul>
<a name="getSchema-java.lang.Object-">
<!-- -->
</a><a name="getSchema-DestinationT-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSchema</h4>
<pre>public abstract&nbsp;<a href="https://static.javadoc.io/com.google.apis/google-api-services-bigquery/v2-rev20211129-1.32.1/com/google/api/services/bigquery/model/TableSchema.html?is-external=true" title="class or interface in com.google.api.services.bigquery.model">TableSchema</a>&nbsp;getSchema(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" title="type parameter in DynamicDestinations">DestinationT</a>&nbsp;destination)</pre>
<div class="block">Returns the table schema for the destination. May not return null.</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/gcp/bigquery/CreateTables.html" title="class in org.apache.beam.sdk.io.gcp.bigquery"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/bigquery/ErrorContainer.html" title="interface in org.apache.beam.sdk.io.gcp.bigquery"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/bigquery/DynamicDestinations.html" target="_top">Frames</a></li>
<li><a href="DynamicDestinations.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>