org.bytedeco.arrow_flight

Class FlightInfo

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow_flight.FlightInfo

All Implemented Interfaces:

AutoCloseable

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

\brief The access coordinates for retireval of a dataset, returned by GetFlightInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightInfo.Data

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
FlightInfo(FlightInfo.Data data)
FlightInfo(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FlightDescriptor	descriptor() The descriptor associated with this flight, may not be set
static Status	Deserialize(BytePointer serialized, FlightInfo out)
static Status	Deserialize(String serialized, FlightInfo out) \brief Parse the wire-format representation of this type.
FlightEndpoint	endpoints() A list of endpoints associated with the flight (dataset).
Status	GetSchema(DictionaryMemo dictionary_memo, Schema out) \brief Deserialize the Arrow schema of the dataset, to be passed to each call to DoGet.
static FlightInfoResult	Make(Schema schema, FlightDescriptor descriptor, FlightEndpoint endpoints, long total_records, long total_bytes) \brief Factory method to construct a FlightInfo.
String	serialized_schema()
Status	SerializeToString(BytePointer out) \brief Get the wire-format representation of this type.
long	total_bytes() The total number of bytes in the dataset.
long	total_records() The total number of records (rows) in the dataset.

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

FlightInfo

public FlightInfo(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FlightInfo

public FlightInfo(@Const @ByRef
                  FlightInfo.Data data)

Method Detail

Make

@ByVal
public static FlightInfoResult Make(@Const @ByRef
                                            Schema schema,
                                            @Const @ByRef
                                            FlightDescriptor descriptor,
                                            @StdVector
                                            FlightEndpoint endpoints,
                                            @Cast(value="int64_t")
                                            long total_records,
                                            @Cast(value="int64_t")
                                            long total_bytes)

\brief Factory method to construct a FlightInfo.

GetSchema

@ByVal
public Status GetSchema(DictionaryMemo dictionary_memo,
                                @SharedPtr
                                Schema out)

\brief Deserialize the Arrow schema of the dataset, to be passed to each call to DoGet. Populate any dictionary encoded fields into a DictionaryMemo for bookkeeping

Parameters:

dictionary_memo - [in,out] for dictionary bookkeeping, will be modified

out - [out] the reconstructed Schema

serialized_schema

@StdString
public String serialized_schema()

descriptor

@Const
 @ByRef
public FlightDescriptor descriptor()

The descriptor associated with this flight, may not be set

endpoints

@StdVector
public FlightEndpoint endpoints()

A list of endpoints associated with the flight (dataset). To consume the whole flight, all endpoints must be consumed

total_records

@Cast(value="int64_t")
public long total_records()

The total number of records (rows) in the dataset. If unknown, set to -1

total_bytes

@Cast(value="int64_t")
public long total_bytes()

The total number of bytes in the dataset. If unknown, set to -1

SerializeToString

@ByVal
public Status SerializeToString(@StdString @Cast(value={"char*","std::string*"})
                                        BytePointer out)

\brief Get the wire-format representation of this type. Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types.

Deserialize

@ByVal
public static Status Deserialize(@StdString
                                         String serialized,
                                         @UniquePtr
                                         FlightInfo out)

\brief Parse the wire-format representation of this type. Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types.

Deserialize

@ByVal
public static Status Deserialize(@StdString
                                         BytePointer serialized,
                                         @UniquePtr
                                         FlightInfo out)