Package org.apache.arrow.flight

Interface Summary

Interface	Description
BackpressureStrategy	Helper interface to dynamically handle backpressure when implementing FlightProducers.
CallHeaders	A set of metadata key value pairs for a call (request or response).
CallOption	Per-call RPC options.
CallOptions.GrpcCallOption	CallOptions specific to GRPC stubs.
FlightClient.ClientStreamListener	Interface for writers to an Arrow data stream.
FlightClient.PutListener	A handler for server-sent application metadata messages during a Flight DoPut operation.
FlightClientMiddleware	Client-side middleware for Flight.
FlightClientMiddleware.Factory	A factory for client middleware instances.
FlightConstants	String constants relevant to flight implementations.
FlightProducer	API to Implement an Arrow Flight producer.
FlightProducer.CallContext	Call-specific context.
FlightProducer.ServerStreamListener	An interface for sending Arrow data back to a client.
FlightProducer.StreamListener<T>	Callbacks for pushing objects to a receiver.
FlightServerMiddleware	Server-side middleware for Flight calls.
FlightServerMiddleware.Factory<T extends FlightServerMiddleware>	A factory for Flight server middleware.
FlightStream.Cancellable	Provides a callback to cancel a process that is in progress.
FlightStream.Requestor	Provides a interface to request more items from a stream producer.
OutboundStreamListener	An interface for writing data to a peer, client or server.
RequestContext	Tracks variables about the current request.
SessionOptionValueVisitor<T>	A visitor interface to access SessionOptionValue's contained value.

Class Summary

Class	Description
Action	An opaque action for the service to perform.
ActionType	POJO wrapper around protocol specifics for Flight actions.
AsyncPutListener	A handler for server-sent application metadata messages during a Flight DoPut operation.
BackpressureStrategy.CallbackBackpressureStrategy	A back pressure strategy that uses callbacks to notify when the client is ready or cancelled.
CallInfo	A description of a Flight call for middleware to inspect.
CallOptions	Common call options.
CallStatus	The result of a Flight RPC, consisting of a status code with an optional description and/or exception that led to the status.
CancelFlightInfoRequest	A request to cancel a FlightInfo.
CancelFlightInfoResult	The result of cancelling a FlightInfo.
CloseSessionRequest	A request to close/invalidate a server session context.
CloseSessionResult	The result of attempting to close/invalidate a server session context.
Criteria	An opaque object that can be used to filter a list of streams available from a server.
ErrorFlightMetadata	metadata container specific to the binary metadata held in the grpc trailer.
FlightCallHeaders	An implementation of the Flight headers interface for headers.
FlightClient	Client for Flight services.
FlightClient.Builder	A builder for Flight clients.
FlightClient.ExchangeReaderWriter	A pair of a reader and a writer for a DoExchange call.
FlightDescriptor	An identifier for a particular set of data.
FlightEndpoint	POJO to convert to/from the underlying protobuf FlightEndpoint.
FlightEndpoint.Builder	Builder for FlightEndpoint.
FlightGrpcUtils	Exposes Flight GRPC service & client.
FlightInfo	A POJO representation of a FlightInfo, metadata associated with a set of data records.
FlightInfo.Builder	Builder for FlightInfo.
FlightServer	Generic server of flight data that is customized via construction with delegate classes for the actual logic.
FlightServer.Builder	A builder for Flight servers.
FlightServerMiddleware.Key<T extends FlightServerMiddleware>	A key for Flight server middleware.
FlightStream	An adaptor between protobuf streams and flight data streams.
GetSessionOptionsRequest	A request to get current session options.
GetSessionOptionsResult	A request to view the currently-set options for the current server session.
HeaderCallOption	Method option for supplying headers to method calls.
Location	A URI where a Flight stream is available.
LocationSchemes	Constants representing well-known URI schemes for Flight services.
NoOpFlightProducer	A FlightProducer that throws on all operations.
NoOpSessionOptionValueVisitor<T>	A helper to facilitate easier anonymous subclass declaration.
NoOpStreamListener<T>	A FlightProducer.StreamListener that does nothing for all callbacks.
PollInfo	A POJO representation of the execution of a long-running query.
PutResult	A message from the server during a DoPut operation.
RenewFlightEndpointRequest	A request to extend the expiration time of a FlightEndpoint.
Result	Opaque result returned after executing an action.
SchemaResult	Opaque result returned after executing a getSchema request.
ServerHeaderMiddleware	Middleware that's used to extract and pass headers to the server during requests.
ServerHeaderMiddleware.Factory	Factory for accessing ServerHeaderMiddleware.
ServerSessionMiddleware	Middleware for handling Flight SQL Sessions including session cookie handling.
ServerSessionMiddleware.Factory	Factory for managing and accessing ServerSessionMiddleware.
ServerSessionMiddleware.Session	A thread-safe container for named SessionOptionValues.
SessionOptionValue	A union-like container interface for supported session option value types.
SessionOptionValueFactory	Abstract factory for concrete SessionOptionValue instances.
SetSessionOptionsRequest	A request to set option(s) in an existing or implicitly-created server session.
SetSessionOptionsResult	The result of attempting to set a set of session options.
SetSessionOptionsResult.Error	Per-option extensible error response container.
SyncPutListener	A listener for server-sent application metadata messages during a Flight DoPut.
Ticket	Endpoint for a particular stream.

Enum Summary

Enum	Description
BackpressureStrategy.WaitResult	The state of the client after a call to waitForListener.
CancelStatus	The result of cancelling a FlightInfo.
CloseSessionResult.Status	Close operation result status values.
FlightMethod	All the RPC methods available in Flight.
FlightStatusCode	A status code describing the result of a Flight call.
SetSessionOptionsResult.ErrorValue	Error status value for per-option errors.

Exception Summary

Exception	Description
FlightRuntimeException	An exception raised from a Flight RPC.