blob: 036c2bb11f4c3fd2a9a730d08c7b270dbc05b727 [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>PubsubWriteSchemaTransformProvider (Apache Beam 2.47.0)</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="PubsubWriteSchemaTransformProvider (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/pubsub/PubsubWriteSchemaTransformConfiguration.TargetConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsub.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html" target="_top">Frames</a></li>
<li><a href="PubsubWriteSchemaTransformProvider.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.pubsub</div>
<h2 title="Class PubsubWriteSchemaTransformProvider" class="title">Class PubsubWriteSchemaTransformProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.gcp.pubsub.PubsubWriteSchemaTransformProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransformProvider</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SCHEMAS">SCHEMAS</a>)
@AutoService(value=<a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransformProvider.class</a>)
public class <span class="typeNameLabel">PubsubWriteSchemaTransformProvider</span>
extends <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">TypedSchemaTransformProvider</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;</pre>
<div class="block">An implementation of <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> for Pub/Sub reads configured using
<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubWriteSchemaTransformConfiguration</code></a>.
<p><b>Internal only:</b> This class is actively being worked on, and it will likely change. We
provide no backwards compatibility guarantees, and it should not be implemented outside the Beam
repository.</div>
</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/pubsub/PubsubWriteSchemaTransformProvider.html#PubsubWriteSchemaTransformProvider--">PubsubWriteSchemaTransformProvider</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="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>protected java.lang.Class&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#configurationClass--">configurationClass</a></span>()</code>
<div class="block">Returns the expected class of the configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#from-org.apache.beam.sdk.io.gcp.pubsub.PubsubWriteSchemaTransformConfiguration-">from</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&nbsp;configuration)</code>
<div class="block">Returns the expected <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransform</code></a> of the configuration.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#identifier--">identifier</a></span>()</code>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransformProvider</code></a> identifier method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#inputCollectionNames--">inputCollectionNames</a></span>()</code>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> inputCollectionNames method.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#outputCollectionNames--">outputCollectionNames</a></span>()</code>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> outputCollectionNames method.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.schemas.transforms.<a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">TypedSchemaTransformProvider</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html#configurationSchema--">configurationSchema</a>, <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html#dependencies-org.apache.beam.sdk.values.Row-org.apache.beam.sdk.options.PipelineOptions-">dependencies</a>, <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html#from-org.apache.beam.sdk.values.Row-">from</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="PubsubWriteSchemaTransformProvider--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PubsubWriteSchemaTransformProvider</h4>
<pre>public&nbsp;PubsubWriteSchemaTransformProvider()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="configurationClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configurationClass</h4>
<pre>protected&nbsp;java.lang.Class&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;&nbsp;configurationClass()</pre>
<div class="block">Returns the expected class of the configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html#configurationClass--">configurationClass</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">TypedSchemaTransformProvider</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="from-org.apache.beam.sdk.io.gcp.pubsub.PubsubWriteSchemaTransformConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms">SchemaTransform</a>&nbsp;from(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&nbsp;configuration)</pre>
<div class="block">Returns the expected <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransform.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransform</code></a> of the configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html#from-ConfigT-">from</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms">TypedSchemaTransformProvider</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformConfiguration.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubWriteSchemaTransformConfiguration</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="identifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifier</h4>
<pre>public&nbsp;java.lang.String&nbsp;identifier()</pre>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/SchemaTransformProvider.html" title="interface in org.apache.beam.sdk.schemas.transforms"><code>SchemaTransformProvider</code></a> identifier method.</div>
</li>
</ul>
<a name="inputCollectionNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputCollectionNames</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;inputCollectionNames()</pre>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> inputCollectionNames method. Since a
single input is expected, this returns a list with a single name.</div>
</li>
</ul>
<a name="outputCollectionNames--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>outputCollectionNames</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;outputCollectionNames()</pre>
<div class="block">Implementation of the <a href="../../../../../../../org/apache/beam/sdk/schemas/transforms/TypedSchemaTransformProvider.html" title="class in org.apache.beam.sdk.schemas.transforms"><code>TypedSchemaTransformProvider</code></a> outputCollectionNames method. The
only expected output is the <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html#ERROR_TAG"><code>ERROR_TAG</code></a>.</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/pubsub/PubsubWriteSchemaTransformConfiguration.TargetConfiguration.Builder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsub.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/PubsubWriteSchemaTransformProvider.html" target="_top">Frames</a></li>
<li><a href="PubsubWriteSchemaTransformProvider.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>