| <!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>org.apache.beam.sdk.io.gcp.spanner.changestreams.model (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="org.apache.beam.sdk.io.gcp.spanner.changestreams.model (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/mapper/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/restriction/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/model/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <p><a href="../../../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.io.gcp.spanner.changestreams.model</h1> |
| <div class="docSummary"> |
| <div class="block">User models for the Spanner change stream API.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChangeStreamRecord.html" title="interface in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChangeStreamRecord</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a Spanner Change Stream Record.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChangeStreamRecordMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChangeStreamRecordMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Holds internal execution metrics / metadata for the processed <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChangeStreamRecord.html" title="interface in org.apache.beam.sdk.io.gcp.spanner.changestreams.model"><code>ChangeStreamRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChangeStreamRecordMetadata.Builder.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChangeStreamRecordMetadata.Builder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChildPartition.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChildPartition</a></td> |
| <td class="colLast"> |
| <div class="block">A child partition represents a new partition that should be queried.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChildPartitionsRecord.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChildPartitionsRecord</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a ChildPartitionsRecord.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ColumnType.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ColumnType</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a column type from a Cloud Spanner table with the following information: column name, |
| column type, flag indicating if column is primary key and column position in the table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">DataChangeRecord</a></td> |
| <td class="colLast"> |
| <div class="block">A data change record encodes modifications to Cloud Spanner rows.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/HeartbeatRecord.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">HeartbeatRecord</a></td> |
| <td class="colLast"> |
| <div class="block">A heartbeat record serves as a notification that the change stream query has returned all changes |
| for the partition less or equal to the record timestamp.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/InitialPartition.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">InitialPartition</a></td> |
| <td class="colLast"> |
| <div class="block">Utility class to determine initial partition constants and methods.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/Mod.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">Mod</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a modification in a table emitted within a <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model"><code>DataChangeRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">PartitionMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Model for the partition metadata database table used in the Connector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.Builder.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">PartitionMetadata.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">Partition metadata builder for better user experience.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/TypeCode.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">TypeCode</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a type of a column within Cloud Spanner.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ModType.html" title="enum in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ModType</a></td> |
| <td class="colLast"> |
| <div class="block">Represents the type of modification applied in the <a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model"><code>DataChangeRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/PartitionMetadata.State.html" title="enum in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">PartitionMetadata.State</a></td> |
| <td class="colLast"> |
| <div class="block">The state at which a partition can be in the system: |
| |
| |
| CREATED: the partition has been created, but no query has been done against it yet.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ValueCaptureType.html" title="enum in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ValueCaptureType</a></td> |
| <td class="colLast"> |
| <div class="block">Represents the capture type of a change stream.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.io.gcp.spanner.changestreams.model Description">Package org.apache.beam.sdk.io.gcp.spanner.changestreams.model Description</h2> |
| <div class="block">User models for the Spanner change stream API.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/mapper/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/restriction/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/model/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
