Package org.apache.arrow.flight.impl

Class FlightServiceGrpc.FlightServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<FlightServiceGrpc.FlightServiceFutureStub>
org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceFutureStub
Enclosing class:
FlightServiceGrpc
public static final class FlightServiceGrpc.FlightServiceFutureStub extends io.grpc.stub.AbstractFutureStub<FlightServiceGrpc.FlightServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service FlightService. 
 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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected FlightServiceGrpc.FlightServiceFutureStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    com.google.common.util.concurrent.ListenableFuture<Flight.FlightInfo>
    getFlightInfo(Flight.FlightDescriptor request)
    For a given FlightDescriptor, get information about how the flight can be consumed.
    com.google.common.util.concurrent.ListenableFuture<Flight.SchemaResult>
    getSchema(Flight.FlightDescriptor request)
    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.
    com.google.common.util.concurrent.ListenableFuture<Flight.PollInfo>
    pollFlightInfo(Flight.FlightDescriptor request)
    For a given FlightDescriptor, start a query and get information to poll its execution status.

    Methods inherited from class io.grpc.stub.AbstractFutureStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

      protected FlightServiceGrpc.FlightServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<FlightServiceGrpc.FlightServiceFutureStub>

    • getFlightInfo

      public com.google.common.util.concurrent.ListenableFuture<Flight.FlightInfo> getFlightInfo(Flight.FlightDescriptor request)
       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.

    • pollFlightInfo

      public com.google.common.util.concurrent.ListenableFuture<Flight.PollInfo> pollFlightInfo(Flight.FlightDescriptor request)
       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.

    • getSchema

      public com.google.common.util.concurrent.ListenableFuture<Flight.SchemaResult> getSchema(Flight.FlightDescriptor request)
       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.