| <!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>KuduTransaction</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="KuduTransaction"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/kudu/client/KuduTableStatistics.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kudu/client/KuduTransaction.html" target="_top">Frames</a></li> |
| <li><a href="KuduTransaction.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.kudu.client</div> |
| <h2 title="Class KuduTransaction" class="title">Class KuduTransaction</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.kudu.client.KuduTransaction</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">KuduTransaction</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">A handle for a multi-row transaction in Kudu. |
| <p> |
| Once created using <a href="../../../../org/apache/kudu/client/KuduClient.html#newTransaction--"><code>KuduClient.newTransaction()</code></a> or |
| <a href="../../../../org/apache/kudu/client/KuduTransaction.html#deserialize-byte:A-org.apache.kudu.client.AsyncKuduClient-"><code>deserialize(byte[], org.apache.kudu.client.AsyncKuduClient)</code></a> methods, an instance of this class |
| can be used to commit or rollback the underlying multi-row transaction. To |
| issue write operations as a part of the transaction, use the |
| <a href="../../../../org/apache/kudu/client/KuduTransaction.html#newKuduSession--"><code>newKuduSession()</code></a> or |
| <a href="../../../../org/apache/kudu/client/KuduTransaction.html#newAsyncKuduSession--"><code>newAsyncKuduSession()</code></a> methods to create a new |
| transactional session and apply write operations using it. |
| <p> |
| The <a href="../../../../org/apache/kudu/client/KuduTransaction.html" title="class in org.apache.kudu.client"><code>KuduTransaction</code></a> implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a> and should be |
| used with try-with-resource code construct. Once an object of this class |
| is constructed, it starts sending automatic keep-alive heartbeat messages |
| to keep the underlying transaction open. Once the object goes out of scope |
| and <a href="../../../../org/apache/kudu/client/KuduTransaction.html#close--"><code>close()</code></a> is automatically called by the Java |
| runtime (or the method is called explicitly), the heartbeating stops and the |
| transaction is automatically aborted by the system after not receiving |
| heartbeat messages for a few keep-alive intervals.</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="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="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/kudu/client/KuduTransaction.html#close--">close</a></span>()</code> |
| <div class="block">Stop keepalive heartbeating, if any was in progress for this transaction |
| handle.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#commit--">commit</a></span>()</code> |
| <div class="block">Commit the multi-row distributed transaction represented by this handle.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/kudu/client/KuduTransaction.html" title="class in org.apache.kudu.client">KuduTransaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#deserialize-byte:A-org.apache.kudu.client.AsyncKuduClient-">deserialize</a></span>(byte[] buf, |
| <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html" title="class in org.apache.kudu.client">AsyncKuduClient</a> client)</code> |
| <div class="block">Re-create KuduTransaction object given its serialized representation.</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/kudu/client/KuduTransaction.html#isCommitComplete--">isCommitComplete</a></span>()</code> |
| <div class="block">Check whether the commit phase for a transaction is complete.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client">AsyncKuduSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#newAsyncKuduSession--">newAsyncKuduSession</a></span>()</code> |
| <div class="block">Create a new <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client"><code>AsyncKuduSession</code></a> based on this transaction.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client">KuduSession</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#newKuduSession--">newKuduSession</a></span>()</code> |
| <div class="block">Create a new <a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client"><code>KuduSession</code></a> based on this transaction.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#rollback--">rollback</a></span>()</code> |
| <div class="block">Rollback the multi-row distributed transaction represented by this object.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#serialize--">serialize</a></span>()</code> |
| <div class="block">A shortcut for the <a href="../../../../org/apache/kudu/client/KuduTransaction.html#serialize-org.apache.kudu.client.KuduTransaction.SerializationOptions-"><code>serialize(SerializationOptions)</code></a> |
| method invoked with default-constructed <code>KuduTransaction.SerializationOptions</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#serialize-org.apache.kudu.client.KuduTransaction.SerializationOptions-">serialize</a></span>(org.apache.kudu.client.KuduTransaction.SerializationOptions options)</code> |
| <div class="block">Export information on the underlying transaction in a serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduTransaction.html#startCommit--">startCommit</a></span>()</code> |
| <div class="block">Start committing the multi-row distributed transaction represented by |
| this handle.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="newAsyncKuduSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newAsyncKuduSession</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client">AsyncKuduSession</a> newAsyncKuduSession()</pre> |
| <div class="block">Create a new <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client"><code>AsyncKuduSession</code></a> based on this transaction. |
| <p> |
| All write operations using the result session will be performed in the |
| context of this transaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client"><code>AsyncKuduSession</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newKuduSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newKuduSession</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client">KuduSession</a> newKuduSession()</pre> |
| <div class="block">Create a new <a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client"><code>KuduSession</code></a> based on this transaction. |
| <p> |
| All write operations using the result session will be performed in the |
| context of this transaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client"><code>KuduSession</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit() |
| throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> |
| <div class="block">Commit the multi-row distributed transaction represented by this handle. |
| <p> |
| This method starts committing the transaction and awaits for the commit |
| phase to finalize.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if something went wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startCommit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startCommit</h4> |
| <pre>public void startCommit() |
| throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> |
| <div class="block">Start committing the multi-row distributed transaction represented by |
| this handle. |
| <p> |
| This method only starts committing the transaction, not awaiting for the |
| commit phase to finalize. Use <a href="../../../../org/apache/kudu/client/KuduTransaction.html#isCommitComplete--"><code>isCommitComplete()</code></a> |
| to check whether the transaction is committed.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if something went wrong upon starting to commit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCommitComplete--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCommitComplete</h4> |
| <pre>public boolean isCommitComplete() |
| throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> |
| <div class="block">Check whether the commit phase for a transaction is complete.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if transaction has finalized, otherwise <code>false</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>NonRecoverableException</code> - with Status.Aborted() |
| if transaction has been or is being aborted</dd> |
| <dd><code>NonRecoverableException</code> - with Status.IllegalState() |
| if transaction is still open (i.e. commit() hasn't been called yet)</dd> |
| <dd><code>NonRecoverableException</code> - with Status.NotSupported() |
| if transaction is in unexpected state (non-compatible backend?)</dd> |
| <dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if an error happens while querying the system about |
| the state of the transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback() |
| throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> |
| <div class="block">Rollback the multi-row distributed transaction represented by this object. |
| <p> |
| This method initiates rolling back the transaction and returns right after |
| that. The system takes care of the rest. Once the control returns and |
| no exception is thrown, a client have a guarantee that all write |
| operations issued in the context of this transaction cannot be seen seen |
| outside.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if something went wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serialize-org.apache.kudu.client.KuduTransaction.SerializationOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>public byte[] serialize(org.apache.kudu.client.KuduTransaction.SerializationOptions options) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Export information on the underlying transaction in a serialized form. |
| <p> |
| This method transforms this handle into its serialized representation. |
| <p> |
| The serialized information on a Kudu transaction can be passed among |
| different Kudu clients running at multiple nodes, so those separate |
| Kudu clients can perform operations to be a part of the same distributed |
| transaction. The resulting string is referred as "transaction token" and |
| it can be deserialized into a transaction handle (i.e. an object of this |
| class) via the <a href="../../../../org/apache/kudu/client/KuduTransaction.html#deserialize-byte:A-org.apache.kudu.client.AsyncKuduClient-"><code>deserialize(byte[], org.apache.kudu.client.AsyncKuduClient)</code></a> method. |
| <p> |
| This method doesn't perform any RPC under the hood. |
| <p> |
| The representation of the data in the serialized form (i.e. the format of |
| a Kudu transaction token) is an implementation detail, not a part of the |
| public API and can be changed without notice.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serialized form of this transaction handle</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if serialization fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serialize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>public byte[] serialize() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">A shortcut for the <a href="../../../../org/apache/kudu/client/KuduTransaction.html#serialize-org.apache.kudu.client.KuduTransaction.SerializationOptions-"><code>serialize(SerializationOptions)</code></a> |
| method invoked with default-constructed <code>KuduTransaction.SerializationOptions</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deserialize-byte:A-org.apache.kudu.client.AsyncKuduClient-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deserialize</h4> |
| <pre>public static <a href="../../../../org/apache/kudu/client/KuduTransaction.html" title="class in org.apache.kudu.client">KuduTransaction</a> deserialize(byte[] buf, |
| <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html" title="class in org.apache.kudu.client">AsyncKuduClient</a> client) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Re-create KuduTransaction object given its serialized representation. |
| <p> |
| This method doesn't perform any RPC under the hood. The newly created |
| object automatically does or does not send keep-alive messages depending |
| on the <code>KuduTransaction.SerializationOptions.isKeepaliveEnabled()</code> setting when |
| the original <a href="../../../../org/apache/kudu/client/KuduTransaction.html" title="class in org.apache.kudu.client"><code>KuduTransaction</code></a> object was serialized using |
| <a href="../../../../org/apache/kudu/client/KuduTransaction.html#serialize-org.apache.kudu.client.KuduTransaction.SerializationOptions-"><code>serialize(org.apache.kudu.client.KuduTransaction.SerializationOptions)</code></a> method. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - Client instance to bound the result object to</dd> |
| <dd><code>buf</code> - serialized representation of a <a href="../../../../org/apache/kudu/client/KuduTransaction.html" title="class in org.apache.kudu.client"><code>KuduTransaction</code></a> object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operation result status.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if deserialization fails</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">Stop keepalive heartbeating, if any was in progress for this transaction |
| handle. |
| <p> |
| This method is called automatically when the object goes out of scope |
| as prescribed for <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>. |
| <p> |
| This method doesn't throw according to the recommendations for |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang"><code>AutoCloseable.close()</code></a>. In case of an error, this method just logs |
| the corresponding error message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></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/kudu/client/KuduTableStatistics.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kudu/client/KuduTransaction.html" target="_top">Frames</a></li> |
| <li><a href="KuduTransaction.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> |