| <!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>TimestampEncoding (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="TimestampEncoding (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/encoder/TimestampEncoding.html" target="_top">Frames</a></li> |
| <li><a href="TimestampEncoding.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><a href="#fields.inherited.from.class.org.apache.avro.reflect.CustomEncoding">Field</a> | </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.encoder</div> |
| <h2 title="Class TimestampEncoding" class="title">Class TimestampEncoding</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">org.apache.avro.reflect.CustomEncoding</a><com.google.cloud.Timestamp></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.spanner.changestreams.encoder.TimestampEncoding</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TimestampEncoding</span> |
| extends <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">CustomEncoding</a><com.google.cloud.Timestamp></pre> |
| <div class="block">This encoder/decoder writes a com.google.cloud.Timestamp object as a pair of long and int to avro |
| and reads a Timestamp object from the same pair. The long stores the number of seconds since |
| January 1, 1970, 00:00:00 UTC. A negative value is the number of seconds before January 1, 1970, |
| 00:00:00 UTC. The int stores the fractional seconds components, in the range 0..999999999.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.avro.reflect.CustomEncoding"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.avro.reflect.<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">CustomEncoding</a></h3> |
| <code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true#schema" title="class or interface in org.apache.avro.reflect">schema</a></code></li> |
| </ul> |
| </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/spanner/changestreams/encoder/TimestampEncoding.html#TimestampEncoding--">TimestampEncoding</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="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>protected com.google.cloud.Timestamp</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/encoder/TimestampEncoding.html#read-java.lang.Object-org.apache.avro.io.Decoder-">read</a></span>(java.lang.Object reuse, |
| <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Decoder.html?is-external=true" title="class or interface in org.apache.avro.io">Decoder</a> in)</code> |
| <div class="block">Deserializes a <code>Timestamp</code> from the given <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Decoder.html?is-external=true" title="class or interface in org.apache.avro.io"><code>Decoder</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/beam/sdk/io/gcp/spanner/changestreams/encoder/TimestampEncoding.html#write-java.lang.Object-org.apache.avro.io.Encoder-">write</a></span>(java.lang.Object datum, |
| <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Encoder.html?is-external=true" title="class or interface in org.apache.avro.io">Encoder</a> out)</code> |
| <div class="block">Serializes a <code>Timestamp</code> received as datum to the output encoder out.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.avro.reflect.CustomEncoding"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.avro.reflect.<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">CustomEncoding</a></h3> |
| <code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true#getSchema--" title="class or interface in org.apache.avro.reflect">getSchema</a></code></li> |
| </ul> |
| <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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TimestampEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TimestampEncoding</h4> |
| <pre>public TimestampEncoding()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="write-java.lang.Object-org.apache.avro.io.Encoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>protected void write(java.lang.Object datum, |
| <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Encoder.html?is-external=true" title="class or interface in org.apache.avro.io">Encoder</a> out) |
| throws java.io.IOException</pre> |
| <div class="block">Serializes a <code>Timestamp</code> received as datum to the output encoder out. A null timestamp is |
| serialized with negative fields (seconds and nanos).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true#write-java.lang.Object-org.apache.avro.io.Encoder-" title="class or interface in org.apache.avro.reflect">write</a></code> in class <code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">CustomEncoding</a><com.google.cloud.Timestamp></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>datum</code> - the <code>Timestamp</code> to be encoded</dd> |
| <dd><code>out</code> - the <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Encoder.html?is-external=true" title="class or interface in org.apache.avro.io"><code>Encoder</code></a> where the timestamp should be serialized to</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if it was not possible to write the timestamp into the provided encoder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="read-java.lang.Object-org.apache.avro.io.Decoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>protected com.google.cloud.Timestamp read(java.lang.Object reuse, |
| <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Decoder.html?is-external=true" title="class or interface in org.apache.avro.io">Decoder</a> in) |
| throws java.io.IOException</pre> |
| <div class="block">Deserializes a <code>Timestamp</code> from the given <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Decoder.html?is-external=true" title="class or interface in org.apache.avro.io"><code>Decoder</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true#read-java.lang.Object-org.apache.avro.io.Decoder-" title="class or interface in org.apache.avro.reflect">read</a></code> in class <code><a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/reflect/CustomEncoding.html?is-external=true" title="class or interface in org.apache.avro.reflect">CustomEncoding</a><com.google.cloud.Timestamp></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reuse</code> - ignored</dd> |
| <dd><code>in</code> - the <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/io/Decoder.html?is-external=true" title="class or interface in org.apache.avro.io"><code>Decoder</code></a> to read the timestamp fields from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if the fields are negative or an instance of a <code>Timestamp</code> instead.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if it was not possible to read the timestamp from the provided decoder</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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/beam/sdk/io/gcp/spanner/changestreams/encoder/TimestampEncoding.html" target="_top">Frames</a></li> |
| <li><a href="TimestampEncoding.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><a href="#fields.inherited.from.class.org.apache.avro.reflect.CustomEncoding">Field</a> | </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> |
