| <!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>FlightClient (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="FlightClient (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"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,"i19":10,"i20":10,"i21":10,"i22":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="class-use/FlightClient.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/FlightCallHeaders.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flight/FlightClient.html" target="_top">Frames</a></li> |
| <li><a href="FlightClient.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><a href="#nested.class.summary">Nested</a> | </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</div> |
| <h2 title="Class FlightClient" class="title">Class FlightClient</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.arrow.flight.FlightClient</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>public class <span class="typeNameLabel">FlightClient</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">Client for Flight services.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight">FlightClient.Builder</a></span></code> |
| <div class="block">A builder for Flight clients.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a></span></code> |
| <div class="block">Interface for writers to an Arrow data stream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.ExchangeReaderWriter.html" title="class in org.apache.arrow.flight">FlightClient.ExchangeReaderWriter</a></span></code> |
| <div class="block">A pair of a reader and a writer for a DoExchange call.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a></span></code> |
| <div class="block">A handler for server-sent application metadata messages during a Flight DoPut operation.</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="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/arrow/flight/FlightClient.html#authenticate-org.apache.arrow.flight.auth.ClientAuthHandler-org.apache.arrow.flight.CallOption...-">authenticate</a></span>(<a href="../../../../org/apache/arrow/flight/auth/ClientAuthHandler.html" title="interface in org.apache.arrow.flight.auth">ClientAuthHandler</a> handler, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Authenticates against the Flight service.</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/arrow/flight/FlightClient.html#authenticateBasic-java.lang.String-java.lang.String-">authenticateBasic</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> |
| <div class="block">Authenticates with a username and password.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../org/apache/arrow/flight/grpc/CredentialCallOption.html" title="class in org.apache.arrow.flight.grpc">CredentialCallOption</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#authenticateBasicToken-java.lang.String-java.lang.String-">authenticateBasicToken</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> |
| <div class="block">Authenticates with a username and password.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight">FlightClient.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#builder--">builder</a></span>()</code> |
| <div class="block">Create a builder for a Flight client.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight">FlightClient.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#builder-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.flight.Location-">builder</a></span>(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../org/apache/arrow/flight/Location.html" title="class in org.apache.arrow.flight">Location</a> location)</code> |
| <div class="block">Create a builder for a Flight client.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/CancelFlightInfoResult.html" title="class in org.apache.arrow.flight">CancelFlightInfoResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-">cancelFlightInfo</a></span>(<a href="../../../../org/apache/arrow/flight/CancelFlightInfoRequest.html" title="class in org.apache.arrow.flight">CancelFlightInfoRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Cancel execution of a distributed query.</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/arrow/flight/FlightClient.html#close--">close</a></span>()</code> |
| <div class="block">Shut down this client.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.CallOption...-">closeSession</a></span>(<a href="../../../../org/apache/arrow/flight/CloseSessionRequest.html" title="class in org.apache.arrow.flight">CloseSessionRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Close/invalidate the current server session.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#doAction-org.apache.arrow.flight.Action-org.apache.arrow.flight.CallOption...-">doAction</a></span>(<a href="../../../../org/apache/arrow/flight/Action.html" title="class in org.apache.arrow.flight">Action</a> action, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Performs an action on the Flight service.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightClient.ExchangeReaderWriter.html" title="class in org.apache.arrow.flight">FlightClient.ExchangeReaderWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#doExchange-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-">doExchange</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Initiate a bidirectional data exchange with the server.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#getInfo-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-">getInfo</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get info on a stream.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#getSchema-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-">getSchema</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get schema for a stream.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-">getSessionOptions</a></span>(<a href="../../../../org/apache/arrow/flight/GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">GetSessionOptionsRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get the current server session options.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#getStream-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.CallOption...-">getStream</a></span>(<a href="../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Retrieve a stream from the server.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#handshake-org.apache.arrow.flight.CallOption...-">handshake</a></span>(<a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Executes the handshake against the Flight service.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/arrow/flight/ActionType.html" title="class in org.apache.arrow.flight">ActionType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#listActions-org.apache.arrow.flight.CallOption...-">listActions</a></span>(<a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Lists actions available on the Flight service.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#listFlights-org.apache.arrow.flight.Criteria-org.apache.arrow.flight.CallOption...-">listFlights</a></span>(<a href="../../../../org/apache/arrow/flight/Criteria.html" title="class in org.apache.arrow.flight">Criteria</a> criteria, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Get a list of available flights.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/PollInfo.html" title="class in org.apache.arrow.flight">PollInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#pollInfo-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-">pollInfo</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Start or get info on execution of a long-running query.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.CallOption...-">renewFlightEndpoint</a></span>(<a href="../../../../org/apache/arrow/flight/RenewFlightEndpointRequest.html" title="class in org.apache.arrow.flight">RenewFlightEndpointRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Request the server to extend the lifetime of a query result set.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-">setSessionOptions</a></span>(<a href="../../../../org/apache/arrow/flight/SetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">SetSessionOptionsRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Set server session option(s) by name/value.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-">startPut</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create or append a descriptor with another stream.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-">startPut</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create or append a descriptor with another stream.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightClient.html#startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-">startPut</a></span>(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</code> |
| <div class="block">Create or append a descriptor with another stream.</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="listFlights-org.apache.arrow.flight.Criteria-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listFlights</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a>> listFlights(<a href="../../../../org/apache/arrow/flight/Criteria.html" title="class in org.apache.arrow.flight">Criteria</a> criteria, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get a list of available flights.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>criteria</code> - Criteria for selecting flights</dd> |
| <dd><code>options</code> - RPC-layer hints for the call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>FlightInfo Iterable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listActions-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listActions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/arrow/flight/ActionType.html" title="class in org.apache.arrow.flight">ActionType</a>> listActions(<a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Lists actions available on the Flight service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for the call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doAction-org.apache.arrow.flight.Action-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doAction</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/arrow/flight/Result.html" title="class in org.apache.arrow.flight">Result</a>> doAction(<a href="../../../../org/apache/arrow/flight/Action.html" title="class in org.apache.arrow.flight">Action</a> action, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Performs an action on the Flight service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>action</code> - The action to perform.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An iterator of results.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="authenticateBasic-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticateBasic</h4> |
| <pre>public void authenticateBasic(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</pre> |
| <div class="block">Authenticates with a username and password.</div> |
| </li> |
| </ul> |
| <a name="authenticate-org.apache.arrow.flight.auth.ClientAuthHandler-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre>public void authenticate(<a href="../../../../org/apache/arrow/flight/auth/ClientAuthHandler.html" title="interface in org.apache.arrow.flight.auth">ClientAuthHandler</a> handler, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Authenticates against the Flight service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dd><code>handler</code> - The auth mechanism to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="authenticateBasicToken-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authenticateBasicToken</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../org/apache/arrow/flight/grpc/CredentialCallOption.html" title="class in org.apache.arrow.flight.grpc">CredentialCallOption</a>> authenticateBasicToken(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</pre> |
| <div class="block">Authenticates with a username and password.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>username</code> - the username.</dd> |
| <dd><code>password</code> - the password.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a CredentialCallOption containing a bearer token if the server emitted one, or |
| empty if no bearer token was returned. This can be used in subsequent API calls.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handshake-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handshake</h4> |
| <pre>public void handshake(<a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Executes the handshake against the Flight service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startPut</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a> startPut(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create or append a descriptor with another stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - FlightDescriptor the descriptor for the data</dd> |
| <dd><code>root</code> - VectorSchemaRoot the root containing data</dd> |
| <dd><code>metadataListener</code> - A handler for metadata messages from the server. This will be passed buffers that will be |
| freed after <a href="../../../../org/apache/arrow/flight/FlightProducer.StreamListener.html#onNext-T-"><code>FlightProducer.StreamListener.onNext(Object)</code></a> is called!</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClientStreamListener an interface to control uploading data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startPut</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a> startPut(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create or append a descriptor with another stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - FlightDescriptor the descriptor for the data</dd> |
| <dd><code>root</code> - VectorSchemaRoot the root containing data</dd> |
| <dd><code>metadataListener</code> - A handler for metadata messages from the server.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClientStreamListener an interface to control uploading data. |
| <a href="../../../../org/apache/arrow/flight/OutboundStreamListener.html#start-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-"><code>OutboundStreamListener.start(VectorSchemaRoot, DictionaryProvider)</code></a> will already have been called.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startPut-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.FlightClient.PutListener-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startPut</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightClient.ClientStreamListener.html" title="interface in org.apache.arrow.flight">FlightClient.ClientStreamListener</a> startPut(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/FlightClient.PutListener.html" title="interface in org.apache.arrow.flight">FlightClient.PutListener</a> metadataListener, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Create or append a descriptor with another stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - FlightDescriptor the descriptor for the data</dd> |
| <dd><code>metadataListener</code> - A handler for metadata messages from the server.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClientStreamListener an interface to control uploading data. |
| <a href="../../../../org/apache/arrow/flight/OutboundStreamListener.html#start-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-"><code>OutboundStreamListener.start(VectorSchemaRoot, DictionaryProvider)</code></a> will NOT already have been called.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInfo-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInfo</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightInfo.html" title="class in org.apache.arrow.flight">FlightInfo</a> getInfo(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get info on a stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - The descriptor for the stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pollInfo-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollInfo</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/PollInfo.html" title="class in org.apache.arrow.flight">PollInfo</a> pollInfo(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Start or get info on execution of a long-running query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - The descriptor for the stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata about execution.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/SchemaResult.html" title="class in org.apache.arrow.flight">SchemaResult</a> getSchema(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get schema for a stream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - The descriptor for the stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStream-org.apache.arrow.flight.Ticket-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStream</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightStream.html" title="class in org.apache.arrow.flight">FlightStream</a> getStream(<a href="../../../../org/apache/arrow/flight/Ticket.html" title="class in org.apache.arrow.flight">Ticket</a> ticket, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Retrieve a stream from the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ticket</code> - The ticket granting access to the data stream.</dd> |
| <dd><code>options</code> - RPC-layer hints for this call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doExchange-org.apache.arrow.flight.FlightDescriptor-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doExchange</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightClient.ExchangeReaderWriter.html" title="class in org.apache.arrow.flight">FlightClient.ExchangeReaderWriter</a> doExchange(<a href="../../../../org/apache/arrow/flight/FlightDescriptor.html" title="class in org.apache.arrow.flight">FlightDescriptor</a> descriptor, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Initiate a bidirectional data exchange with the server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>descriptor</code> - A descriptor for the data stream.</dd> |
| <dd><code>options</code> - RPC call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A pair of a readable stream and a writable stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancelFlightInfo-org.apache.arrow.flight.CancelFlightInfoRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelFlightInfo</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/CancelFlightInfoResult.html" title="class in org.apache.arrow.flight">CancelFlightInfoResult</a> cancelFlightInfo(<a href="../../../../org/apache/arrow/flight/CancelFlightInfoRequest.html" title="class in org.apache.arrow.flight">CancelFlightInfoRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Cancel execution of a distributed query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The query to cancel.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The server response.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renewFlightEndpoint-org.apache.arrow.flight.RenewFlightEndpointRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewFlightEndpoint</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/FlightEndpoint.html" title="class in org.apache.arrow.flight">FlightEndpoint</a> renewFlightEndpoint(<a href="../../../../org/apache/arrow/flight/RenewFlightEndpointRequest.html" title="class in org.apache.arrow.flight">RenewFlightEndpointRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Request the server to extend the lifetime of a query result set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The result set partition.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new endpoint with an updated expiration time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSessionOptions-org.apache.arrow.flight.SetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionOptions</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/SetSessionOptionsResult.html" title="class in org.apache.arrow.flight">SetSessionOptionsResult</a> setSessionOptions(<a href="../../../../org/apache/arrow/flight/SetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">SetSessionOptionsRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Set server session option(s) by name/value. |
| |
| Sessions are generally persisted via HTTP cookies.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The session options to set on the server.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The result containing per-value error statuses, if any.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSessionOptions-org.apache.arrow.flight.GetSessionOptionsRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionOptions</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/GetSessionOptionsResult.html" title="class in org.apache.arrow.flight">GetSessionOptionsResult</a> getSessionOptions(<a href="../../../../org/apache/arrow/flight/GetSessionOptionsRequest.html" title="class in org.apache.arrow.flight">GetSessionOptionsRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Get the current server session options. |
| |
| The session is generally accessed via an HTTP cookie.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The (empty) GetSessionOptionsRequest.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The result containing the set of session options configured on the server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeSession-org.apache.arrow.flight.CloseSessionRequest-org.apache.arrow.flight.CallOption...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeSession</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flight/CloseSessionResult.html" title="class in org.apache.arrow.flight">CloseSessionResult</a> closeSession(<a href="../../../../org/apache/arrow/flight/CloseSessionRequest.html" title="class in org.apache.arrow.flight">CloseSessionRequest</a> request, |
| <a href="../../../../org/apache/arrow/flight/CallOption.html" title="interface in org.apache.arrow.flight">CallOption</a>... options)</pre> |
| <div class="block">Close/invalidate the current server session. |
| |
| The session is generally accessed via an HTTP cookie.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The (empty) CloseSessionRequest.</dd> |
| <dd><code>options</code> - Call options.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The result containing the status of the close operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Shut down this client.</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> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight">FlightClient.Builder</a> builder()</pre> |
| <div class="block">Create a builder for a Flight client.</div> |
| </li> |
| </ul> |
| <a name="builder-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.flight.Location-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight">FlightClient.Builder</a> builder(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../org/apache/arrow/flight/Location.html" title="class in org.apache.arrow.flight">Location</a> location)</pre> |
| <div class="block">Create a builder for a Flight client.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocator</code> - The allocator to use for the client.</dd> |
| <dd><code>location</code> - The location to connect to.</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/FlightClient.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/FlightCallHeaders.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flight/FlightClient.Builder.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flight/FlightClient.html" target="_top">Frames</a></li> |
| <li><a href="FlightClient.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><a href="#nested.class.summary">Nested</a> | </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> |
