| <!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>DataChangeRecord (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="DataChangeRecord (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":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/model/ColumnType.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><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"><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/model/DataChangeRecord.html" target="_top">Frames</a></li> |
| <li><a href="DataChangeRecord.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><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.spanner.changestreams.model</div> |
| <h2 title="Class DataChangeRecord" class="title">Class DataChangeRecord</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.model.DataChangeRecord</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <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></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../../../../org/apache/beam/sdk/coders/DefaultCoder.html" title="annotation in org.apache.beam.sdk.coders">@DefaultCoder</a>(<a href="../../../../../../../../../org/apache/beam/sdk/coders/DefaultCoder.html#value--">value</a>=<a href="../../../../../../../../../org/apache/beam/sdk/extensions/avro/coders/AvroCoder.html" title="class in org.apache.beam.sdk.extensions.avro.coders">AvroCoder.class</a>) |
| public class <span class="typeNameLabel">DataChangeRecord</span> |
| extends java.lang.Object |
| implements <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></pre> |
| <div class="block">A data change record encodes modifications to Cloud Spanner rows. A record will contain one or |
| more modifications made in one table with the same <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"><code>ModType</code></a>. There can be multiple data |
| change records for a transaction and commit timestamp.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../serialized-form.html#org.apache.beam.sdk.io.gcp.spanner.changestreams.model.DataChangeRecord">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </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/spanner/changestreams/model/DataChangeRecord.html#DataChangeRecord-java.lang.String-com.google.cloud.Timestamp-java.lang.String-boolean-java.lang.String-java.lang.String-java.util.List-java.util.List-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ModType-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ValueCaptureType-long-long-java.lang.String-boolean-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ChangeStreamRecordMetadata-">DataChangeRecord</a></span>(java.lang.String partitionToken, |
| com.google.cloud.Timestamp commitTimestamp, |
| java.lang.String serverTransactionId, |
| boolean isLastRecordInTransactionInPartition, |
| java.lang.String recordSequence, |
| java.lang.String tableName, |
| java.util.List<<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>> rowType, |
| java.util.List<<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>> mods, |
| <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> modType, |
| <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> valueCaptureType, |
| long numberOfRecordsInTransaction, |
| long numberOfPartitionsInTransaction, |
| java.lang.String transactionTag, |
| boolean isSystemTransaction, |
| <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> metadata)</code> |
| <div class="block">Constructs a data change record for a given partition, at a given timestamp, for a given |
| transaction.</div> |
| </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="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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.cloud.Timestamp</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getCommitTimestamp--">getCommitTimestamp</a></span>()</code> |
| <div class="block">The timestamp at which the modifications within were committed in Cloud Spanner.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getMetadata--">getMetadata</a></span>()</code> |
| <div class="block">The connector execution metadata for this record.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getMods--">getMods</a></span>()</code> |
| <div class="block">The modifications within this record.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getModType--">getModType</a></span>()</code> |
| <div class="block">The type of operation that caused the modifications within this record.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getNumberOfPartitionsInTransaction--">getNumberOfPartitionsInTransaction</a></span>()</code> |
| <div class="block">The total number of partitions for the given transaction.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getNumberOfRecordsInTransaction--">getNumberOfRecordsInTransaction</a></span>()</code> |
| <div class="block">The total number of data change records for the given transaction.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getPartitionToken--">getPartitionToken</a></span>()</code> |
| <div class="block">The unique identifier of the partition that generated this record.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getRecordSequence--">getRecordSequence</a></span>()</code> |
| <div class="block">Indicates the order in which this record was put into the change stream in the scope of a |
| partition, commit timestamp and transaction tuple.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>com.google.cloud.Timestamp</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getRecordTimestamp--">getRecordTimestamp</a></span>()</code> |
| <div class="block">The timestamp at which the modifications within were committed in Cloud Spanner.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getRowType--">getRowType</a></span>()</code> |
| <div class="block">The type of the primary keys and modified columns within this record.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getServerTransactionId--">getServerTransactionId</a></span>()</code> |
| <div class="block">The unique transaction id in which the modifications occurred.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getTableName--">getTableName</a></span>()</code> |
| <div class="block">The name of the table in which the modifications within this record occurred.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getTransactionTag--">getTransactionTag</a></span>()</code> |
| <div class="block">The transaction tag associated with the given transaction.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#getValueCaptureType--">getValueCaptureType</a></span>()</code> |
| <div class="block">The capture type of the change stream that generated this record.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#isLastRecordInTransactionInPartition--">isLastRecordInTransactionInPartition</a></span>()</code> |
| <div class="block">Indicates whether this record is the last emitted for the given transaction in the given |
| partition.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/model/DataChangeRecord.html#isSystemTransaction--">isSystemTransaction</a></span>()</code> |
| <div class="block">Whether the given transaction is Spanner system transaction.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/DataChangeRecord.html#toString--">toString</a></span>()</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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DataChangeRecord-java.lang.String-com.google.cloud.Timestamp-java.lang.String-boolean-java.lang.String-java.lang.String-java.util.List-java.util.List-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ModType-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ValueCaptureType-long-long-java.lang.String-boolean-org.apache.beam.sdk.io.gcp.spanner.changestreams.model.ChangeStreamRecordMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DataChangeRecord</h4> |
| <pre>public DataChangeRecord(java.lang.String partitionToken, |
| com.google.cloud.Timestamp commitTimestamp, |
| java.lang.String serverTransactionId, |
| boolean isLastRecordInTransactionInPartition, |
| java.lang.String recordSequence, |
| java.lang.String tableName, |
| java.util.List<<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>> rowType, |
| java.util.List<<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>> mods, |
| <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> modType, |
| <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> valueCaptureType, |
| long numberOfRecordsInTransaction, |
| long numberOfPartitionsInTransaction, |
| java.lang.String transactionTag, |
| boolean isSystemTransaction, |
| <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> metadata)</pre> |
| <div class="block">Constructs a data change record for a given partition, at a given timestamp, for a given |
| transaction. The data change record needs to be given information about the table modified, the |
| type of primary keys and modified columns, the modifications themselves and other metadata.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>partitionToken</code> - the unique identifier of the partition that generated this record</dd> |
| <dd><code>commitTimestamp</code> - the timestamp at which the modifications within were committed in Cloud |
| Spanner</dd> |
| <dd><code>serverTransactionId</code> - the unique transaction id in which the modifications occurred</dd> |
| <dd><code>isLastRecordInTransactionInPartition</code> - indicates whether this record is the last emitted |
| for the given transaction in the given partition</dd> |
| <dd><code>recordSequence</code> - indicates the order in which this record was put into the change stream |
| in the scope of a partition, commit timestamp and transaction tuple</dd> |
| <dd><code>tableName</code> - the name of the table in which the modifications occurred</dd> |
| <dd><code>rowType</code> - the type of the primary keys and modified columns</dd> |
| <dd><code>mods</code> - the modifications occurred</dd> |
| <dd><code>modType</code> - the operation that caused the modification to occur</dd> |
| <dd><code>valueCaptureType</code> - the capture type of the change stream</dd> |
| <dd><code>numberOfRecordsInTransaction</code> - the total number of records for the given transaction</dd> |
| <dd><code>numberOfPartitionsInTransaction</code> - the total number of partitions within the given |
| transaction</dd> |
| <dd><code>transactionTag</code> - the transaction tag associated with the given transaction</dd> |
| <dd><code>isSystemTransaction</code> - whether the given transaction is Spanner system transaction (or user |
| transaction)</dd> |
| <dd><code>metadata</code> - connector execution metadata for the given record</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRecordTimestamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecordTimestamp</h4> |
| <pre>public com.google.cloud.Timestamp getRecordTimestamp()</pre> |
| <div class="block">The timestamp at which the modifications within were committed in Cloud Spanner.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/model/ChangeStreamRecord.html#getRecordTimestamp--">getRecordTimestamp</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timestamp at which this record has occurred.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartitionToken--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionToken</h4> |
| <pre>public java.lang.String getPartitionToken()</pre> |
| <div class="block">The unique identifier of the partition that generated this record.</div> |
| </li> |
| </ul> |
| <a name="getCommitTimestamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommitTimestamp</h4> |
| <pre>public com.google.cloud.Timestamp getCommitTimestamp()</pre> |
| <div class="block">The timestamp at which the modifications within were committed in Cloud Spanner.</div> |
| </li> |
| </ul> |
| <a name="getServerTransactionId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerTransactionId</h4> |
| <pre>public java.lang.String getServerTransactionId()</pre> |
| <div class="block">The unique transaction id in which the modifications occurred.</div> |
| </li> |
| </ul> |
| <a name="isLastRecordInTransactionInPartition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLastRecordInTransactionInPartition</h4> |
| <pre>public boolean isLastRecordInTransactionInPartition()</pre> |
| <div class="block">Indicates whether this record is the last emitted for the given transaction in the given |
| partition.</div> |
| </li> |
| </ul> |
| <a name="getRecordSequence--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecordSequence</h4> |
| <pre>public java.lang.String getRecordSequence()</pre> |
| <div class="block">Indicates the order in which this record was put into the change stream in the scope of a |
| partition, commit timestamp and transaction tuple.</div> |
| </li> |
| </ul> |
| <a name="getTableName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableName</h4> |
| <pre>public java.lang.String getTableName()</pre> |
| <div class="block">The name of the table in which the modifications within this record occurred.</div> |
| </li> |
| </ul> |
| <a name="getRowType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowType</h4> |
| <pre>public java.util.List<<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>> getRowType()</pre> |
| <div class="block">The type of the primary keys and modified columns within this record.</div> |
| </li> |
| </ul> |
| <a name="getMods--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMods</h4> |
| <pre>public java.util.List<<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>> getMods()</pre> |
| <div class="block">The modifications within this record.</div> |
| </li> |
| </ul> |
| <a name="getModType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModType</h4> |
| <pre>public <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> getModType()</pre> |
| <div class="block">The type of operation that caused the modifications within this record.</div> |
| </li> |
| </ul> |
| <a name="getValueCaptureType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueCaptureType</h4> |
| <pre>public <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> getValueCaptureType()</pre> |
| <div class="block">The capture type of the change stream that generated this record.</div> |
| </li> |
| </ul> |
| <a name="getNumberOfRecordsInTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberOfRecordsInTransaction</h4> |
| <pre>public long getNumberOfRecordsInTransaction()</pre> |
| <div class="block">The total number of data change records for the given transaction.</div> |
| </li> |
| </ul> |
| <a name="getNumberOfPartitionsInTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberOfPartitionsInTransaction</h4> |
| <pre>public long getNumberOfPartitionsInTransaction()</pre> |
| <div class="block">The total number of partitions for the given transaction.</div> |
| </li> |
| </ul> |
| <a name="getTransactionTag--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionTag</h4> |
| <pre>public java.lang.String getTransactionTag()</pre> |
| <div class="block">The transaction tag associated with the given transaction.</div> |
| </li> |
| </ul> |
| <a name="isSystemTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSystemTransaction</h4> |
| <pre>public boolean isSystemTransaction()</pre> |
| <div class="block">Whether the given transaction is Spanner system transaction. Otherwise it is user/application |
| transaction.</div> |
| </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/model/ChangeStreamRecordMetadata.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model">ChangeStreamRecordMetadata</a> getMetadata()</pre> |
| <div class="block">The connector execution metadata for this record.</div> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| java.lang.Object o)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</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/model/ColumnType.html" title="class in org.apache.beam.sdk.io.gcp.spanner.changestreams.model"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><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"><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/model/DataChangeRecord.html" target="_top">Frames</a></li> |
| <li><a href="DataChangeRecord.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><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> |
