| <!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>FlightServiceGrpc.FlightServiceStub (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="FlightServiceGrpc.FlightServiceStub (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FlightServiceGrpc.FlightServiceStub.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/impl/FlightServiceGrpc.FlightServiceImplBase.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" target="_top">Frames</a></li> |
| <li><a href="FlightServiceGrpc.FlightServiceStub.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.classes.inherited.from.class.io.grpc.stub.AbstractStub">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.impl</div> |
| <h2 title="Class FlightServiceGrpc.FlightServiceStub" class="title">Class FlightServiceGrpc.FlightServiceStub</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>io.grpc.stub.AbstractStub<S></li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.grpc.stub.AbstractAsyncStub<<a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <span class="typeNameLabel">FlightServiceGrpc.FlightServiceStub</span> |
| extends io.grpc.stub.AbstractAsyncStub<<a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a>></pre> |
| <div class="block">A stub to allow clients to do asynchronous rpc calls to service FlightService. |
| <pre> |
| A flight service is an endpoint for retrieving or storing Arrow data. A |
| flight service can expose one or more predefined endpoints that can be |
| accessed using the Arrow Flight Protocol. Additionally, a flight service |
| can expose a set of actions that are available. |
| </pre></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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.io.grpc.stub.AbstractStub"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub</h3> |
| <code>io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#build-io.grpc.Channel-io.grpc.CallOptions-">build</a></span>(io.grpc.Channel channel, |
| io.grpc.CallOptions callOptions)</code> </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/impl/FlightServiceGrpc.FlightServiceStub.html#doAction-org.apache.arrow.flight.impl.Flight.Action-io.grpc.stub.StreamObserver-">doAction</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.Result.html" title="class in org.apache.arrow.flight.impl">Flight.Result</a>> responseObserver)</code> |
| <div class="block"> |
| Flight services can support an arbitrary number of simple actions in |
| addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut |
| operations that are potentially available.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#doExchange-io.grpc.stub.StreamObserver-">doExchange</a></span>(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> responseObserver)</code> |
| <div class="block"> |
| Open a bidirectional data channel for a given descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#doGet-org.apache.arrow.flight.impl.Flight.Ticket-io.grpc.stub.StreamObserver-">doGet</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Ticket.html" title="class in org.apache.arrow.flight.impl">Flight.Ticket</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> responseObserver)</code> |
| <div class="block"> |
| Retrieve a single stream associated with a particular descriptor |
| associated with the referenced ticket.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#doPut-io.grpc.stub.StreamObserver-">doPut</a></span>(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.PutResult.html" title="class in org.apache.arrow.flight.impl">Flight.PutResult</a>> responseObserver)</code> |
| <div class="block"> |
| Push a stream to the flight service associated with a particular |
| flight stream.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#getFlightInfo-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-">getFlightInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo</a>> responseObserver)</code> |
| <div class="block"> |
| For a given FlightDescriptor, get information about how the flight can be |
| consumed.</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/impl/FlightServiceGrpc.FlightServiceStub.html#getSchema-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-">getSchema</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.SchemaResult.html" title="class in org.apache.arrow.flight.impl">Flight.SchemaResult</a>> responseObserver)</code> |
| <div class="block"> |
| For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema |
| This is used when a consumer needs the Schema of flight stream.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.HandshakeRequest.html" title="class in org.apache.arrow.flight.impl">Flight.HandshakeRequest</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#handshake-io.grpc.stub.StreamObserver-">handshake</a></span>(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.HandshakeResponse.html" title="class in org.apache.arrow.flight.impl">Flight.HandshakeResponse</a>> responseObserver)</code> |
| <div class="block"> |
| Handshake between client and server.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#listActions-org.apache.arrow.flight.impl.Flight.Empty-io.grpc.stub.StreamObserver-">listActions</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Empty.html" title="class in org.apache.arrow.flight.impl">Flight.Empty</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a>> responseObserver)</code> |
| <div class="block"> |
| A flight service exposes all of the available action types that it has |
| along with descriptions.</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/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#listFlights-org.apache.arrow.flight.impl.Flight.Criteria-io.grpc.stub.StreamObserver-">listFlights</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Criteria.html" title="class in org.apache.arrow.flight.impl">Flight.Criteria</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo</a>> responseObserver)</code> |
| <div class="block"> |
| Get a list of available streams given a particular criteria.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html#pollFlightInfo-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-">pollFlightInfo</a></span>(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.PollInfo.html" title="class in org.apache.arrow.flight.impl">Flight.PollInfo</a>> responseObserver)</code> |
| <div class="block"> |
| For a given FlightDescriptor, start a query and get information |
| to poll its execution status.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.io.grpc.stub.AbstractAsyncStub"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class io.grpc.stub.AbstractAsyncStub</h3> |
| <code>newStub, newStub</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.io.grpc.stub.AbstractStub"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class io.grpc.stub.AbstractStub</h3> |
| <code>getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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="build-io.grpc.Channel-io.grpc.CallOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a> build(io.grpc.Channel channel, |
| io.grpc.CallOptions callOptions)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>build</code> in class <code>io.grpc.stub.AbstractStub<<a href="../../../../../org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" title="class in org.apache.arrow.flight.impl">FlightServiceGrpc.FlightServiceStub</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handshake-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handshake</h4> |
| <pre>public io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.HandshakeRequest.html" title="class in org.apache.arrow.flight.impl">Flight.HandshakeRequest</a>> handshake(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.HandshakeResponse.html" title="class in org.apache.arrow.flight.impl">Flight.HandshakeResponse</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Handshake between client and server. Depending on the server, the |
| handshake may be required to determine the token that should be used for |
| future operations. Both request and response are streams to allow multiple |
| round-trips depending on auth mechanism. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="listFlights-org.apache.arrow.flight.impl.Flight.Criteria-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listFlights</h4> |
| <pre>public void listFlights(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Criteria.html" title="class in org.apache.arrow.flight.impl">Flight.Criteria</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Get a list of available streams given a particular criteria. Most flight |
| services will expose one or more streams that are readily available for |
| retrieval. This api allows listing the streams available for |
| consumption. A user can also provide a criteria. The criteria can limit |
| the subset of streams that can be listed via this interface. Each flight |
| service allows its own definition of how to consume criteria. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getFlightInfo-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlightInfo</h4> |
| <pre>public void getFlightInfo(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightInfo.html" title="class in org.apache.arrow.flight.impl">Flight.FlightInfo</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| For a given FlightDescriptor, get information about how the flight can be |
| consumed. This is a useful interface if the consumer of the interface |
| already can identify the specific flight to consume. This interface can |
| also allow a consumer to generate a flight stream through a specified |
| descriptor. For example, a flight descriptor might be something that |
| includes a SQL statement or a Pickled Python operation that will be |
| executed. In those cases, the descriptor will not be previously available |
| within the list of available streams provided by ListFlights but will be |
| available for consumption for the duration defined by the specific flight |
| service. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="pollFlightInfo-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollFlightInfo</h4> |
| <pre>public void pollFlightInfo(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.PollInfo.html" title="class in org.apache.arrow.flight.impl">Flight.PollInfo</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| For a given FlightDescriptor, start a query and get information |
| to poll its execution status. This is a useful interface if the |
| query may be a long-running query. The first PollFlightInfo call |
| should return as quickly as possible. (GetFlightInfo doesn't |
| return until the query is complete.) |
| A client can consume any available results before |
| the query is completed. See PollInfo.info for details. |
| A client can poll the updated query status by calling |
| PollFlightInfo() with PollInfo.flight_descriptor. A server |
| should not respond until the result would be different from last |
| time. That way, the client can "long poll" for updates |
| without constantly making requests. Clients can set a short timeout |
| to avoid blocking calls if desired. |
| A client can't use PollInfo.flight_descriptor after |
| PollInfo.expiration_time passes. A server might not accept the |
| retry descriptor anymore and the query may be cancelled. |
| A client may use the CancelFlightInfo action with |
| PollInfo.info to cancel the running query. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.arrow.flight.impl.Flight.FlightDescriptor-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public void getSchema(<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightDescriptor.html" title="class in org.apache.arrow.flight.impl">Flight.FlightDescriptor</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.SchemaResult.html" title="class in org.apache.arrow.flight.impl">Flight.SchemaResult</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema |
| This is used when a consumer needs the Schema of flight stream. Similar to |
| GetFlightInfo this interface may generate a new flight that was not previously |
| available in ListFlights. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="doGet-org.apache.arrow.flight.impl.Flight.Ticket-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doGet</h4> |
| <pre>public void doGet(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Ticket.html" title="class in org.apache.arrow.flight.impl">Flight.Ticket</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Retrieve a single stream associated with a particular descriptor |
| associated with the referenced ticket. A Flight can be composed of one or |
| more streams where each stream can be retrieved using a separate opaque |
| ticket that the flight service uses for managing a collection of streams. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="doPut-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doPut</h4> |
| <pre>public io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> doPut(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.PutResult.html" title="class in org.apache.arrow.flight.impl">Flight.PutResult</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Push a stream to the flight service associated with a particular |
| flight stream. This allows a client of a flight service to upload a stream |
| of data. Depending on the particular flight service, a client consumer |
| could be allowed to upload a single stream per descriptor or an unlimited |
| number. In the latter, the service might implement a 'seal' action that |
| can be applied to a descriptor once all streams are uploaded. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="doExchange-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doExchange</h4> |
| <pre>public io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> doExchange(io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.FlightData.html" title="class in org.apache.arrow.flight.impl">Flight.FlightData</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Open a bidirectional data channel for a given descriptor. This |
| allows clients to send and receive arbitrary Arrow data and |
| application-specific metadata in a single logical stream. In |
| contrast to DoGet/DoPut, this is more suited for clients |
| offloading computation (rather than storage) to a Flight service. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="doAction-org.apache.arrow.flight.impl.Flight.Action-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doAction</h4> |
| <pre>public void doAction(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Action.html" title="class in org.apache.arrow.flight.impl">Flight.Action</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.Result.html" title="class in org.apache.arrow.flight.impl">Flight.Result</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| Flight services can support an arbitrary number of simple actions in |
| addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut |
| operations that are potentially available. DoAction allows a flight client |
| to do a specific action against a flight service. An action includes |
| opaque request and response objects that are specific to the type action |
| being undertaken. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="listActions-org.apache.arrow.flight.impl.Flight.Empty-io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>listActions</h4> |
| <pre>public void listActions(<a href="../../../../../org/apache/arrow/flight/impl/Flight.Empty.html" title="class in org.apache.arrow.flight.impl">Flight.Empty</a> request, |
| io.grpc.stub.StreamObserver<<a href="../../../../../org/apache/arrow/flight/impl/Flight.ActionType.html" title="class in org.apache.arrow.flight.impl">Flight.ActionType</a>> responseObserver)</pre> |
| <div class="block"><pre> |
| A flight service exposes all of the available action types that it has |
| along with descriptions. This allows different flight consumers to |
| understand the capabilities of the flight service. |
| </pre></div> |
| </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/FlightServiceGrpc.FlightServiceStub.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/impl/FlightServiceGrpc.FlightServiceImplBase.html" title="class in org.apache.arrow.flight.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/impl/FlightServiceGrpc.FlightServiceStub.html" target="_top">Frames</a></li> |
| <li><a href="FlightServiceGrpc.FlightServiceStub.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.classes.inherited.from.class.io.grpc.stub.AbstractStub">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> |
