| <!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>PubsubLiteIO (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="PubsubLiteIO (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/pubsublite/PublisherOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteReadSchemaTransformProvider.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html" target="_top">Frames</a></li> |
| <li><a href="PubsubLiteIO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.pubsublite</div> |
| <h2 title="Class PubsubLiteIO" class="title">Class PubsubLiteIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.pubsublite.PubsubLiteIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> |
| public final class <span class="typeNameLabel">PubsubLiteIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">I/O transforms for reading from Google Pub/Sub Lite. |
| |
| <p>For the differences between this and Google Pub/Sub, please refer to the <a |
| href="https://cloud.google.com/pubsub/docs/choosing-pubsub-or-lite">product documentation</a>. |
| |
| <h3>Updates to the I/O connector code</h3> |
| |
| For any significant updates to this I/O connector, please consider involving corresponding code |
| reviewers mentioned <a |
| href="https://github.com/apache/beam/blob/master/sdks/java/io/google-cloud-platform/OWNERS"> |
| here</a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html#addUuids--">addUuids</a></span>()</code> |
| <div class="block">Add Uuids to to-be-published messages that ensures that uniqueness is maintained.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html#deduplicate-org.apache.beam.sdk.io.gcp.pubsublite.UuidDeduplicationOptions-">deduplicate</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/UuidDeduplicationOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">UuidDeduplicationOptions</a> options)</code> |
| <div class="block">Remove duplicates from the PTransform from a read.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html#read-org.apache.beam.sdk.io.gcp.pubsublite.SubscriberOptions-">read</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/SubscriberOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">SubscriberOptions</a> options)</code> |
| <div class="block">Read messages from Pub/Sub Lite.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html#write-org.apache.beam.sdk.io.gcp.pubsublite.PublisherOptions-">write</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PublisherOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">PublisherOptions</a> options)</code> |
| <div class="block">Write messages to Pub/Sub Lite.</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 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="read-org.apache.beam.sdk.io.gcp.pubsublite.SubscriberOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>> read(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/SubscriberOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">SubscriberOptions</a> options)</pre> |
| <div class="block">Read messages from Pub/Sub Lite. These messages may contain duplicates if the publisher |
| retried, which the PubsubLiteIO write method will do. Use the dedupe transform to remove these |
| duplicates. |
| |
| <p>Note that this will not pick up newly added partitions. To pick up new partitions, drain and |
| restart the pipeline. |
| |
| <pre><code> |
| Pipeline p = ...; |
| |
| SubscriptionPath subscriptionPath = |
| SubscriptionPath.newBuilder() |
| .setLocation(zone) |
| .setProjectNumber(projectNum) |
| .setName(subscriptionName) |
| .build(); |
| |
| PCollection<SequencedMessage> messages = p.apply(PubsubLiteIO.read(SubscriberOptions.newBuilder() |
| .setSubscriptionPath(subscriptionPath) |
| .build()), "read"); |
| </code></pre></div> |
| </li> |
| </ul> |
| <a name="deduplicate-org.apache.beam.sdk.io.gcp.pubsublite.UuidDeduplicationOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deduplicate</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.SequencedMessage>> deduplicate(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/UuidDeduplicationOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">UuidDeduplicationOptions</a> options)</pre> |
| <div class="block">Remove duplicates from the PTransform from a read. Assumes by default that the uuids were added |
| by a call to PubsubLiteIO.addUuids() when published. |
| |
| <pre><code> |
| PCollection<SequencedMessage> messages = ... (above) ...; |
| messages = messages.apply(PubsubLiteIO.deduplicate( |
| UuidDeduplicationOptions.newBuilder().build())); |
| |
| </code></pre></div> |
| </li> |
| </ul> |
| <a name="addUuids--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addUuids</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>> addUuids()</pre> |
| <div class="block">Add Uuids to to-be-published messages that ensures that uniqueness is maintained. |
| |
| <pre><code> |
| PCollection<Message> messages = ...; |
| messages = messages.apply(PubsubLiteIO.addUuids()); |
| |
| </code></pre></div> |
| </li> |
| </ul> |
| <a name="write-org.apache.beam.sdk.io.gcp.pubsublite.PublisherOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><com.google.cloud.pubsublite.proto.PubSubMessage>,<a href="../../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a>> write(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PublisherOptions.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite">PublisherOptions</a> options)</pre> |
| <div class="block">Write messages to Pub/Sub Lite. |
| |
| <pre><code> |
| TopicPath topicPath = |
| TopicPath.newBuilder() |
| .setProjectNumber(projectNum) |
| .setLocation(zone) |
| .setName(topicName) |
| .build(); |
| |
| PCollection<Message> messages = ...; |
| messages.apply(PubsubLiteIO.write( |
| PublisherOptions.newBuilder().setTopicPath(topicPath).build()); |
| |
| </code></pre></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/pubsublite/PublisherOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteReadSchemaTransformProvider.html" title="class in org.apache.beam.sdk.io.gcp.pubsublite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsublite/PubsubLiteIO.html" target="_top">Frames</a></li> |
| <li><a href="PubsubLiteIO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
