| <!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>PubsubClient (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="PubsubClient (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":10,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":9,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":9,"i18":9,"i19":9,"i20":6,"i21":6,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/pubsub/ExternalWrite.WriteBuilder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.IncomingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html" target="_top">Frames</a></li> |
| <li><a href="PubsubClient.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 PubsubClient" class="title">Class PubsubClient</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.pubsub.PubsubClient</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Closeable, java.lang.AutoCloseable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubGrpcClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubGrpcClient</a>, <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubJsonClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubJsonClient</a>, <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubTestClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubTestClient</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">PubsubClient</span> |
| extends java.lang.Object |
| implements java.io.Closeable</pre> |
| <div class="block">An (abstract) helper class for talking to Pubsub via an underlying transport.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.IncomingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.IncomingMessage</a></span></code> |
| <div class="block">A message received from Pubsub.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.OutgoingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.OutgoingMessage</a></span></code> |
| <div class="block">A message to be sent to Pubsub.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a></span></code> |
| <div class="block">Path representing a cloud project id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.PubsubClientFactory.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.PubsubClientFactory</a></span></code> |
| <div class="block">Factory for creating clients.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a></span></code> |
| <div class="block">Path representing a Pubsub schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a></span></code> |
| <div class="block">Path representing a Pubsub subscription.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a></span></code> |
| <div class="block">Path representing a Pubsub topic.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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"> </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/PubsubClient.html#PubsubClient--">PubsubClient</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#ackDeadlineSeconds-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-">ackDeadlineSeconds</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription)</code> |
| <div class="block">Return the ack deadline, in seconds, for <code>subscription</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#acknowledge-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-java.util.List-">acknowledge</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| java.util.List<java.lang.String> ackIds)</code> |
| <div class="block">Acknowldege messages from <code>subscription</code> with <code>ackIds</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#createRandomSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-int-">createRandomSubscription</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| int ackDeadlineSeconds)</code> |
| <div class="block">Create a random subscription for <code>topic</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#createSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-java.lang.String-com.google.pubsub.v1.Schema.Type-">createSchema</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath, |
| java.lang.String schemaContent, |
| com.google.pubsub.v1.Schema.Type type)</code> |
| <div class="block">Create <a href="https://static.javadoc.io/com.google.apis/google-api-services-pubsub/v1-rev20220904-2.0.0/com/google/api/services/pubsub/model/Schema.html?is-external=true" title="class or interface in com.google.api.services.pubsub.model"><code>Schema</code></a> from Schema definition content.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#createSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-">createSubscription</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| int ackDeadlineSeconds)</code> |
| <div class="block">Create <code>subscription</code> to <code>topic</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#createTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-">createTopic</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic)</code> |
| <div class="block">Create <code>topic</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#createTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-">createTopic</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schema)</code> |
| <div class="block">Create {link TopicPath} with <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#deleteSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-">deleteSchema</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath)</code> |
| <div class="block">Delete <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#deleteSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-">deleteSubscription</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription)</code> |
| <div class="block">Delete <code>subscription</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#deleteTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-">deleteTopic</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#extractTimestampAttribute-java.lang.String-java.util.Map-">extractTimestampAttribute</a></span>(java.lang.String timestampAttribute, |
| <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.util.Map<java.lang.String,java.lang.String> attributes)</code> |
| <div class="block">Return the timestamp (in ms since unix epoch) to use for a Pubsub message with <code>timestampAttribute</code> and <code>attriutes</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#getSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-">getSchema</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath)</code> |
| <div class="block">Return a Beam <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> from the Pub/Sub schema resource, if exists.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#getSchemaPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-">getSchemaPath</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topicPath)</code> |
| <div class="block">Return <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a> from <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.TopicPath</code></a> if exists.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#isEOF--">isEOF</a></span>()</code> |
| <div class="block">Return true if <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#pull-long-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-boolean-"><code>pull(long, org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath, int, boolean)</code></a> will always return empty list.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#listSubscriptions-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-">listSubscriptions</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic)</code> |
| <div class="block">Return a list of subscriptions for <code>topic</code> in <code>project</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#listTopics-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-">listTopics</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project)</code> |
| <div class="block">Return a list of topics for <code>project</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#modifyAckDeadline-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-java.util.List-int-">modifyAckDeadline</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| java.util.List<java.lang.String> ackIds, |
| int deadlineSeconds)</code> |
| <div class="block">Modify the ack deadline for messages from <code>subscription</code> with <code>ackIds</code> to be <code>deadlineSeconds</code> from now.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected static java.lang.Long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#parseTimestampAsMsSinceEpoch-java.lang.String-">parseTimestampAsMsSinceEpoch</a></span>(java.lang.String timestamp)</code> |
| <div class="block">Return timestamp as ms-since-unix-epoch corresponding to <code>timestamp</code>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#projectPathFromId-java.lang.String-">projectPathFromId</a></span>(java.lang.String projectId)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#projectPathFromPath-java.lang.String-">projectPathFromPath</a></span>(java.lang.String path)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#publish-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-java.util.List-">publish</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.OutgoingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.OutgoingMessage</a>> outgoingMessages)</code> |
| <div class="block">Publish <code>outgoingMessages</code> to Pubsub <code>topic</code>.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.IncomingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.IncomingMessage</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#pull-long-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-boolean-">pull</a></span>(long requestTimeMsSinceEpoch, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| int batchSize, |
| boolean returnImmediately)</code> |
| <div class="block">Request the next batch of up to <code>batchSize</code> messages from <code>subscription</code>.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#schemaPathFromId-java.lang.String-java.lang.String-">schemaPathFromId</a></span>(java.lang.String projectId, |
| java.lang.String schemaId)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#schemaPathFromPath-java.lang.String-">schemaPathFromPath</a></span>(java.lang.String path)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#subscriptionPathFromName-java.lang.String-java.lang.String-">subscriptionPathFromName</a></span>(java.lang.String projectId, |
| java.lang.String subscriptionName)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#subscriptionPathFromPath-java.lang.String-">subscriptionPathFromPath</a></span>(java.lang.String path)</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#topicPathFromName-java.lang.String-java.lang.String-">topicPathFromName</a></span>(java.lang.String projectId, |
| java.lang.String topicName)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#topicPathFromPath-java.lang.String-">topicPathFromPath</a></span>(java.lang.String path)</code> </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.io.Closeable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.io.Closeable</h3> |
| <code>close</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="PubsubClient--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PubsubClient</h4> |
| <pre>public PubsubClient()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parseTimestampAsMsSinceEpoch-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseTimestampAsMsSinceEpoch</h4> |
| <pre>protected static java.lang.Long parseTimestampAsMsSinceEpoch(java.lang.String timestamp)</pre> |
| <div class="block">Return timestamp as ms-since-unix-epoch corresponding to <code>timestamp</code>. Throw <code>IllegalArgumentException</code> if timestamp cannot be recognized.</div> |
| </li> |
| </ul> |
| <a name="extractTimestampAttribute-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractTimestampAttribute</h4> |
| <pre>protected static long extractTimestampAttribute(java.lang.String timestampAttribute, |
| <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.util.Map<java.lang.String,java.lang.String> attributes)</pre> |
| <div class="block">Return the timestamp (in ms since unix epoch) to use for a Pubsub message with <code>timestampAttribute</code> and <code>attriutes</code>. |
| |
| <p>The message attributes must contain <code>timestampAttribute</code>, and the value of that |
| attribute will be taken as the timestamp.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the timestamp cannot be recognized as a ms-since-unix-epoch |
| or RFC3339 time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="projectPathFromPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectPathFromPath</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> projectPathFromPath(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a name="projectPathFromId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectPathFromId</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> projectPathFromId(java.lang.String projectId)</pre> |
| </li> |
| </ul> |
| <a name="schemaPathFromPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schemaPathFromPath</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPathFromPath(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a name="schemaPathFromId-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schemaPathFromId</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPathFromId(java.lang.String projectId, |
| java.lang.String schemaId)</pre> |
| </li> |
| </ul> |
| <a name="subscriptionPathFromPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subscriptionPathFromPath</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscriptionPathFromPath(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a name="subscriptionPathFromName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subscriptionPathFromName</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscriptionPathFromName(java.lang.String projectId, |
| java.lang.String subscriptionName)</pre> |
| </li> |
| </ul> |
| <a name="topicPathFromPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>topicPathFromPath</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topicPathFromPath(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a name="topicPathFromName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>topicPathFromName</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topicPathFromName(java.lang.String projectId, |
| java.lang.String topicName)</pre> |
| </li> |
| </ul> |
| <a name="publish-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>publish</h4> |
| <pre>public abstract int publish(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.OutgoingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.OutgoingMessage</a>> outgoingMessages) |
| throws java.io.IOException</pre> |
| <div class="block">Publish <code>outgoingMessages</code> to Pubsub <code>topic</code>. Return number of messages published.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pull-long-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pull</h4> |
| <pre>public abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.IncomingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.IncomingMessage</a>> pull(long requestTimeMsSinceEpoch, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| int batchSize, |
| boolean returnImmediately) |
| throws java.io.IOException</pre> |
| <div class="block">Request the next batch of up to <code>batchSize</code> messages from <code>subscription</code>. Return |
| the received messages, or empty collection if none were available. Does not wait for messages |
| to arrive if <code>returnImmediately</code> is true. Returned messages will record their |
| request time as <code>requestTimeMsSinceEpoch</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acknowledge-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acknowledge</h4> |
| <pre>public abstract void acknowledge(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| java.util.List<java.lang.String> ackIds) |
| throws java.io.IOException</pre> |
| <div class="block">Acknowldege messages from <code>subscription</code> with <code>ackIds</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="modifyAckDeadline-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-java.util.List-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modifyAckDeadline</h4> |
| <pre>public abstract void modifyAckDeadline(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| java.util.List<java.lang.String> ackIds, |
| int deadlineSeconds) |
| throws java.io.IOException</pre> |
| <div class="block">Modify the ack deadline for messages from <code>subscription</code> with <code>ackIds</code> to be <code>deadlineSeconds</code> from now.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTopic</h4> |
| <pre>public abstract void createTopic(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic) |
| throws java.io.IOException</pre> |
| <div class="block">Create <code>topic</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTopic</h4> |
| <pre>public abstract void createTopic(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schema) |
| throws java.io.IOException</pre> |
| <div class="block">Create {link TopicPath} with <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteTopic-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTopic</h4> |
| <pre>public abstract void deleteTopic(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listTopics-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listTopics</h4> |
| <pre>public abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a>> listTopics(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project) |
| throws java.io.IOException</pre> |
| <div class="block">Return a list of topics for <code>project</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubscription</h4> |
| <pre>public abstract void createSubscription(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription, |
| int ackDeadlineSeconds) |
| throws java.io.IOException</pre> |
| <div class="block">Create <code>subscription</code> to <code>topic</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRandomSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRandomSubscription</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> createRandomSubscription(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic, |
| int ackDeadlineSeconds) |
| throws java.io.IOException</pre> |
| <div class="block">Create a random subscription for <code>topic</code>. Return the <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SubscriptionPath</code></a>. It is the |
| responsibility of the caller to later delete the subscription.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteSubscription-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteSubscription</h4> |
| <pre>public abstract void deleteSubscription(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription) |
| throws java.io.IOException</pre> |
| <div class="block">Delete <code>subscription</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listSubscriptions-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.ProjectPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listSubscriptions</h4> |
| <pre>public abstract java.util.List<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a>> listSubscriptions(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a> project, |
| <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topic) |
| throws java.io.IOException</pre> |
| <div class="block">Return a list of subscriptions for <code>topic</code> in <code>project</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ackDeadlineSeconds-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ackDeadlineSeconds</h4> |
| <pre>public abstract int ackDeadlineSeconds(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a> subscription) |
| throws java.io.IOException</pre> |
| <div class="block">Return the ack deadline, in seconds, for <code>subscription</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEOF--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEOF</h4> |
| <pre>public abstract boolean isEOF()</pre> |
| <div class="block">Return true if <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html#pull-long-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath-int-boolean-"><code>pull(long, org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SubscriptionPath, int, boolean)</code></a> will always return empty list. Actual clients will |
| return false. Test clients may return true to signal that all expected |
| messages have been pulled and the test may complete.</div> |
| </li> |
| </ul> |
| <a name="createSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-java.lang.String-com.google.pubsub.v1.Schema.Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSchema</h4> |
| <pre>public abstract void createSchema(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath, |
| java.lang.String schemaContent, |
| com.google.pubsub.v1.Schema.Type type) |
| throws java.io.IOException</pre> |
| <div class="block">Create <a href="https://static.javadoc.io/com.google.apis/google-api-services-pubsub/v1-rev20220904-2.0.0/com/google/api/services/pubsub/model/Schema.html?is-external=true" title="class or interface in com.google.api.services.pubsub.model"><code>Schema</code></a> from Schema definition content.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteSchema</h4> |
| <pre>public abstract void deleteSchema(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath) |
| throws java.io.IOException</pre> |
| <div class="block">Delete <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaPath-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.TopicPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaPath</h4> |
| <pre>public abstract <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> getSchemaPath(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a> topicPath) |
| throws java.io.IOException</pre> |
| <div class="block">Return <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.SchemaPath</code></a> from <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubClient.TopicPath</code></a> if exists.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.beam.sdk.io.gcp.pubsub.PubsubClient.SchemaPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public abstract <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> getSchema(<a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SchemaPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SchemaPath</a> schemaPath) |
| throws java.io.IOException</pre> |
| <div class="block">Return a Beam <a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> from the Pub/Sub schema resource, if exists.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </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/ExternalWrite.WriteBuilder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.IncomingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.html" target="_top">Frames</a></li> |
| <li><a href="PubsubClient.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
