| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FlightSql.ActionCreatePreparedStatementResultOrBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</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="FlightSql.ActionCreatePreparedStatementResultOrBuilder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html">Use</a></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/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.Builder.html" title="class in org.apache.arrow.flight.sql.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedSubstraitPlanRequest.html" title="class in org.apache.arrow.flight.sql.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="FlightSql.ActionCreatePreparedStatementResultOrBuilder.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.arrow.flight.sql.impl</div> |
| <h2 title="Interface FlightSql.ActionCreatePreparedStatementResultOrBuilder" class="title">Interface FlightSql.ActionCreatePreparedStatementResultOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementResult</a>, <a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.Builder.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql.ActionCreatePreparedStatementResult.Builder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.html" title="class in org.apache.arrow.flight.sql.impl">FlightSql</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">FlightSql.ActionCreatePreparedStatementResultOrBuilder</span> |
| extends com.google.protobuf.MessageOrBuilder</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html#getDatasetSchema--">getDatasetSchema</a></span>()</code> |
| <div class="block"> |
| If a result set generating query was provided, dataset_schema contains the |
| schema of the result set.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html#getParameterSchema--">getParameterSchema</a></span>()</code> |
| <div class="block"> |
| If the query provided contained parameters, parameter_schema contains the |
| schema of the expected parameters.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html#getPreparedStatementHandle--">getPreparedStatementHandle</a></span>()</code> |
| <div class="block"> |
| Opaque handle for the prepared statement on the server.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageOrBuilder</h3> |
| <code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder</h3> |
| <code>isInitialized</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="getPreparedStatementHandle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPreparedStatementHandle</h4> |
| <pre>com.google.protobuf.ByteString getPreparedStatementHandle()</pre> |
| <div class="block"><pre> |
| Opaque handle for the prepared statement on the server. |
| </pre> |
| |
| <code>bytes prepared_statement_handle = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The preparedStatementHandle.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatasetSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatasetSchema</h4> |
| <pre>com.google.protobuf.ByteString getDatasetSchema()</pre> |
| <div class="block"><pre> |
| If a result set generating query was provided, dataset_schema contains the |
| schema of the result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs. |
| For some queries, the schema of the results may depend on the schema of the parameters. The server |
| should provide its best guess as to the schema at this point. Clients must not assume that this |
| schema, if provided, will be accurate. |
| </pre> |
| |
| <code>bytes dataset_schema = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The datasetSchema.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getParameterSchema</h4> |
| <pre>com.google.protobuf.ByteString getParameterSchema()</pre> |
| <div class="block"><pre> |
| If the query provided contained parameters, parameter_schema contains the |
| schema of the expected parameters. It should be an IPC-encapsulated Schema, as described in Schema.fbs. |
| </pre> |
| |
| <code>bytes parameter_schema = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parameterSchema.</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="class-use/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html">Use</a></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/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResult.Builder.html" title="class in org.apache.arrow.flight.sql.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedSubstraitPlanRequest.html" title="class in org.apache.arrow.flight.sql.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/flight/sql/impl/FlightSql.ActionCreatePreparedStatementResultOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="FlightSql.ActionCreatePreparedStatementResultOrBuilder.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
