org.apache.arrow.flight.impl

Class FlightServiceGrpc.FlightServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<FlightServiceGrpc.FlightServiceBlockingStub>

org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceBlockingStub

Enclosing class:

FlightServiceGrpc

public static final class FlightServiceGrpc.FlightServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<FlightServiceGrpc.FlightServiceBlockingStub>

 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 and Description
protected FlightServiceGrpc.FlightServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Iterator<Flight.Result>	doAction(Flight.Action request) Flight services can support an arbitrary number of simple actions in addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut operations that are potentially available.
Iterator<Flight.FlightData>	doGet(Flight.Ticket request) Retrieve a single stream associated with a particular descriptor associated with the referenced ticket.
Flight.FlightInfo	getFlightInfo(Flight.FlightDescriptor request) For a given FlightDescriptor, get information about how the flight can be consumed.
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.
Iterator<Flight.ActionType>	listActions(Flight.Empty request) A flight service exposes all of the available action types that it has along with descriptions.
Iterator<Flight.FlightInfo>	listFlights(Flight.Criteria request) Get a list of available streams given a particular criteria.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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 Detail

build

protected FlightServiceGrpc.FlightServiceBlockingStub build(io.grpc.Channel channel,
                                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<FlightServiceGrpc.FlightServiceBlockingStub>

listFlights

public Iterator<Flight.FlightInfo> listFlights(Flight.Criteria request)

 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.
 

getFlightInfo

public 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.
 

getSchema

public 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.
 

doGet

public Iterator<Flight.FlightData> doGet(Flight.Ticket request)

 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.
 

doAction

public Iterator<Flight.Result> doAction(Flight.Action request)

 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.
 

listActions

public Iterator<Flight.ActionType> listActions(Flight.Empty request)

 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.