| <!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>ChangeStreamResultSet (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ChangeStreamResultSet (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":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/spanner/changestreams/dao/ChangeStreamDao.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSetMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html" target="_top">Frames</a></li> |
| <li><a href="ChangeStreamResultSet.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.spanner.changestreams.dao</div> |
| <h2 title="Class ChangeStreamResultSet" class="title">Class ChangeStreamResultSet</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.spanner.changestreams.dao.ChangeStreamResultSet</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ChangeStreamResultSet</span> |
| extends java.lang.Object |
| implements java.lang.AutoCloseable</pre> |
| <div class="block">Decorator class over a <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/ResultSet.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>ResultSet</code></a> that provides telemetry for the streamed records. It |
| will be returned for a change stream query. By using this class one can obtain the following |
| metadata: |
| |
| <ul> |
| <li>The timestamp at which the query first started. |
| <li>The timestamp at which a record streaming started. |
| <li>The timestamp at which a record streaming ended. |
| <li>The timestamp at which a record was read by the caller. |
| <li>The total time for streaming all records within the query. |
| <li>The total number of records streamed within the query. |
| </ul></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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html#close--">close</a></span>()</code> |
| <div class="block">Closes the current change stream <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/ResultSet.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>ResultSet</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/Struct.html?is-external=true" title="class or interface in com.google.cloud.spanner">Struct</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html#getCurrentRowAsStruct--">getCurrentRowAsStruct</a></span>()</code> |
| <div class="block">Returns the record at the current pointer as a <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/Struct.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>Struct</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSetMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao">ChangeStreamResultSetMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html#getMetadata--">getMetadata</a></span>()</code> |
| <div class="block">Returns the gathered metadata for the change stream query so far.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html#next--">next</a></span>()</code> |
| <div class="block">Moves the pointer to the next record in the <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/ResultSet.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>ResultSet</code></a> if there is one.</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="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>public boolean next()</pre> |
| <div class="block">Moves the pointer to the next record in the <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/ResultSet.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>ResultSet</code></a> if there is one. It also gathers |
| metrics for the next record, such as: |
| |
| <ul> |
| <li>If this is the first record consumed, updates the time at which the query started. |
| <li>The timestamp at which a record streaming started. |
| <li>The timestamp at which a record streaming ended. |
| <li>Increments the total time for streaming the all the records so far. |
| <li>Increments the total number of all the records streamed so far. |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if there is another record within the result set. Returns false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentRowAsStruct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentRowAsStruct</h4> |
| <pre>public <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/Struct.html?is-external=true" title="class or interface in com.google.cloud.spanner">Struct</a> getCurrentRowAsStruct()</pre> |
| <div class="block">Returns the record at the current pointer as a <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/Struct.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>Struct</code></a>. It also updates the timestamp at |
| which the record was read. |
| |
| <p>If <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html#next--"><code>next()</code></a> was not called or if it was called but there are no |
| more records in the stream, null will be returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a change stream record as a <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/Struct.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>Struct</code></a> or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre>public <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSetMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao">ChangeStreamResultSetMetadata</a> getMetadata()</pre> |
| <div class="block">Returns the gathered metadata for the change stream query so far.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSetMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao"><code>ChangeStreamResultSetMetadata</code></a> contained telemetry information for the query |
| so far</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Closes the current change stream <a href="https://static.javadoc.io/com.google.cloud/google-cloud-spanner/6.20.0/com/google/cloud/spanner/ResultSet.html?is-external=true" title="class or interface in com.google.cloud.spanner"><code>ResultSet</code></a>. The stream will be terminated when this |
| method is called. |
| |
| <p>This method must always be called after the consumption of the result set or when an error |
| occurs. This makes sure there are no Session leaks and all the underlying resources are |
| released.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</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/spanner/changestreams/dao/ChangeStreamDao.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSetMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.dao"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/dao/ChangeStreamResultSet.html" target="_top">Frames</a></li> |
| <li><a href="ChangeStreamResultSet.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> |
