org.bytedeco.arrow_flight

Class FlightClient

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_flight.FlightClient

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::flight")
 @NoOffset
 @Properties(inherit=arrow_flight.class)
public class FlightClient
extends Pointer

\brief Client class for Arrow Flight RPC services (gRPC-based). API experimental for now

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlightClient(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Authenticate(FlightCallOptions options, ClientAuthHandler auth_handler) \brief Authenticate to the server using the given handler.
StringPairResult	AuthenticateBasicToken(FlightCallOptions options, BytePointer username, BytePointer password)
StringPairResult	AuthenticateBasicToken(FlightCallOptions options, String username, String password) \brief Authenticate to the server using basic HTTP style authentication.
static Status	Connect(Location location, FlightClient client) \brief Connect to an unauthenticated flight service
static Status	Connect(Location location, FlightClientOptions options, FlightClient client) \brief Connect to an unauthenticated flight service
Status	DoAction(Action action, ResultStream results)
Status	DoAction(FlightCallOptions options, Action action, ResultStream results) \brief Perform the indicated action, returning an iterator to the stream of results, if any
Status	DoExchange(FlightCallOptions options, FlightDescriptor descriptor, FlightStreamWriter writer, FlightStreamReader reader)
Status	DoExchange(FlightDescriptor descriptor, FlightStreamWriter writer, FlightStreamReader reader)
Status	DoGet(FlightCallOptions options, Ticket ticket, FlightStreamReader stream) \brief Given a flight ticket and schema, request to be sent the stream.
Status	DoGet(Ticket ticket, FlightStreamReader stream)
Status	DoPut(FlightCallOptions options, FlightDescriptor descriptor, Schema schema, FlightStreamWriter stream, FlightMetadataReader reader) \brief Upload data to a Flight described by the given descriptor.
Status	DoPut(FlightDescriptor descriptor, Schema schema, FlightStreamWriter stream, FlightMetadataReader reader)
Status	GetFlightInfo(FlightCallOptions options, FlightDescriptor descriptor, FlightInfo info) \brief Request access plan for a single flight, which may be an existing dataset or a command to be executed
Status	GetFlightInfo(FlightDescriptor descriptor, FlightInfo info)
Status	GetSchema(FlightCallOptions options, FlightDescriptor descriptor, SchemaResult schema_result) \brief Request schema for a single flight, which may be an existing dataset or a command to be executed
Status	GetSchema(FlightDescriptor descriptor, SchemaResult schema_result)
Status	ListActions(ActionType actions)
Status	ListActions(FlightCallOptions options, ActionType actions) \brief Retrieve a list of available Action types
Status	ListFlights(FlightCallOptions options, Criteria criteria, FlightListing listing) \brief List available flights given indicated filter criteria
Status	ListFlights(FlightListing listing) \brief List all available flights known to the server

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FlightClient

public FlightClient(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Connect

@ByVal
public static Status Connect(@Const @ByRef
                                     Location location,
                                     @UniquePtr
                                     FlightClient client)

\brief Connect to an unauthenticated flight service

Parameters:

location - [in] the URI

client - [out] the created FlightClient

Returns:

Status OK status may not indicate that the connection was successful

Connect

@ByVal
public static Status Connect(@Const @ByRef
                                     Location location,
                                     @Const @ByRef
                                     FlightClientOptions options,
                                     @UniquePtr
                                     FlightClient client)

\brief Connect to an unauthenticated flight service

Parameters:

location - [in] the URI

options - [in] Other options for setting up the client

client - [out] the created FlightClient

Returns:

Status OK status may not indicate that the connection was successful

Authenticate

@ByVal
public Status Authenticate(@Const @ByRef
                                   FlightCallOptions options,
                                   @UniquePtr
                                   ClientAuthHandler auth_handler)

\brief Authenticate to the server using the given handler.

Parameters:

options - [in] Per-RPC options

auth_handler - [in] The authentication mechanism to use

Returns:

Status OK if the client authenticated successfully

AuthenticateBasicToken

@ByVal
public StringPairResult AuthenticateBasicToken(@Const @ByRef
                                                       FlightCallOptions options,
                                                       @StdString
                                                       String username,
                                                       @StdString
                                                       String password)

\brief Authenticate to the server using basic HTTP style authentication.

Parameters:

options - [in] Per-RPC options

username - [in] Username to use

password - [in] Password to use

Returns:

Arrow result with bearer token and status OK if client authenticated sucessfully

AuthenticateBasicToken

@ByVal
public StringPairResult AuthenticateBasicToken(@Const @ByRef
                                                       FlightCallOptions options,
                                                       @StdString
                                                       BytePointer username,
                                                       @StdString
                                                       BytePointer password)

DoAction

@ByVal
public Status DoAction(@Const @ByRef
                               FlightCallOptions options,
                               @Const @ByRef
                               Action action,
                               @UniquePtr
                               ResultStream results)

\brief Perform the indicated action, returning an iterator to the stream of results, if any

Parameters:

options - [in] Per-RPC options

action - [in] the action to be performed

results - [out] an iterator object for reading the returned results

Returns:

Status

DoAction

@ByVal
public Status DoAction(@Const @ByRef
                               Action action,
                               @UniquePtr
                               ResultStream results)

ListActions

@ByVal
public Status ListActions(@Const @ByRef
                                  FlightCallOptions options,
                                  @StdVector
                                  ActionType actions)

\brief Retrieve a list of available Action types

Parameters:

options - [in] Per-RPC options

actions - [out] the available actions

Returns:

Status

ListActions

@ByVal
public Status ListActions(@StdVector
                                  ActionType actions)

GetFlightInfo

@ByVal
public Status GetFlightInfo(@Const @ByRef
                                    FlightCallOptions options,
                                    @Const @ByRef
                                    FlightDescriptor descriptor,
                                    @UniquePtr
                                    FlightInfo info)

\brief Request access plan for a single flight, which may be an existing dataset or a command to be executed

Parameters:

options - [in] Per-RPC options

descriptor - [in] the dataset request, whether a named dataset or command

info - [out] the FlightInfo describing where to access the dataset

Returns:

Status

GetFlightInfo

@ByVal
public Status GetFlightInfo(@Const @ByRef
                                    FlightDescriptor descriptor,
                                    @UniquePtr
                                    FlightInfo info)

GetSchema

@ByVal
public Status GetSchema(@Const @ByRef
                                FlightCallOptions options,
                                @Const @ByRef
                                FlightDescriptor descriptor,
                                @UniquePtr
                                SchemaResult schema_result)

\brief Request schema for a single flight, which may be an existing dataset or a command to be executed

Parameters:

options - [in] Per-RPC options

descriptor - [in] the dataset request, whether a named dataset or command

schema_result - [out] the SchemaResult describing the dataset schema

Returns:

Status

GetSchema

@ByVal
public Status GetSchema(@Const @ByRef
                                FlightDescriptor descriptor,
                                @UniquePtr
                                SchemaResult schema_result)

ListFlights

@ByVal
public Status ListFlights(@UniquePtr
                                  FlightListing listing)

\brief List all available flights known to the server

Parameters:

listing - [out] an iterator that returns a FlightInfo for each flight

Returns:

Status

ListFlights

@ByVal
public Status ListFlights(@Const @ByRef
                                  FlightCallOptions options,
                                  @Const @ByRef
                                  Criteria criteria,
                                  @UniquePtr
                                  FlightListing listing)

\brief List available flights given indicated filter criteria

Parameters:

options - [in] Per-RPC options

criteria - [in] the filter criteria (opaque)

listing - [out] an iterator that returns a FlightInfo for each flight

Returns:

Status

DoGet

@ByVal
public Status DoGet(@Const @ByRef
                            FlightCallOptions options,
                            @Const @ByRef
                            Ticket ticket,
                            @UniquePtr
                            FlightStreamReader stream)

\brief Given a flight ticket and schema, request to be sent the stream. Returns record batch stream reader

Parameters:

options - [in] Per-RPC options

ticket - [in] The flight ticket to use

stream - [out] the returned RecordBatchReader

Returns:

Status

DoGet

@ByVal
public Status DoGet(@Const @ByRef
                            Ticket ticket,
                            @UniquePtr
                            FlightStreamReader stream)

DoPut

@ByVal
public Status DoPut(@Const @ByRef
                            FlightCallOptions options,
                            @Const @ByRef
                            FlightDescriptor descriptor,
                            @Const @SharedPtr @ByRef
                            Schema schema,
                            @UniquePtr
                            FlightStreamWriter stream,
                            @UniquePtr
                            FlightMetadataReader reader)

\brief Upload data to a Flight described by the given descriptor. The caller must call Close() on the returned stream once they are done writing. The reader and writer are linked; closing the writer will also close the reader. Use \a DoneWriting to only close the write side of the channel.

Parameters:

options - [in] Per-RPC options

descriptor - [in] the descriptor of the stream

schema - [in] the schema for the data to upload

stream - [out] a writer to write record batches to

reader - [out] a reader for application metadata from the server

Returns:

Status

DoPut

@ByVal
public Status DoPut(@Const @ByRef
                            FlightDescriptor descriptor,
                            @Const @SharedPtr @ByRef
                            Schema schema,
                            @UniquePtr
                            FlightStreamWriter stream,
                            @UniquePtr
                            FlightMetadataReader reader)

DoExchange

@ByVal
public Status DoExchange(@Const @ByRef
                                 FlightCallOptions options,
                                 @Const @ByRef
                                 FlightDescriptor descriptor,
                                 @UniquePtr
                                 FlightStreamWriter writer,
                                 @UniquePtr
                                 FlightStreamReader reader)

DoExchange

@ByVal
public Status DoExchange(@Const @ByRef
                                 FlightDescriptor descriptor,
                                 @UniquePtr
                                 FlightStreamWriter writer,
                                 @UniquePtr
                                 FlightStreamReader reader)