org.apache.arrow.flight.impl

Interface Flight.FlightInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Flight.FlightInfo, Flight.FlightInfo.Builder

Enclosing class:

Flight

public static interface Flight.FlightInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Flight.FlightEndpoint	getEndpoint(int index) A list of endpoints associated with the flight.
int	getEndpointCount() A list of endpoints associated with the flight.
List<Flight.FlightEndpoint>	getEndpointList() A list of endpoints associated with the flight.
Flight.FlightEndpointOrBuilder	getEndpointOrBuilder(int index) A list of endpoints associated with the flight.
List<? extends Flight.FlightEndpointOrBuilder>	getEndpointOrBuilderList() A list of endpoints associated with the flight.
Flight.FlightDescriptor	getFlightDescriptor() The descriptor associated with this info.
Flight.FlightDescriptorOrBuilder	getFlightDescriptorOrBuilder() The descriptor associated with this info.
boolean	getOrdered() FlightEndpoints are in the same order as the data.
com.google.protobuf.ByteString	getSchema() The schema of the dataset in its IPC form: 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix 4 bytes - the byte length of the payload a flatbuffer Message whose header is the Schema
long	getTotalBytes() int64 total_bytes = 5;
long	getTotalRecords() Set these to -1 if unknown.
boolean	hasFlightDescriptor() The descriptor associated with this info.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSchema

com.google.protobuf.ByteString getSchema()

 The schema of the dataset in its IPC form:
   4 bytes - an optional IPC_CONTINUATION_TOKEN prefix
   4 bytes - the byte length of the payload
   a flatbuffer Message whose header is the Schema
 

bytes schema = 1;

Returns:

The schema.

hasFlightDescriptor

boolean hasFlightDescriptor()

 The descriptor associated with this info.
 

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Returns:

Whether the flightDescriptor field is set.

getFlightDescriptor

Flight.FlightDescriptor getFlightDescriptor()

 The descriptor associated with this info.
 

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Returns:

The flightDescriptor.

getFlightDescriptorOrBuilder

Flight.FlightDescriptorOrBuilder getFlightDescriptorOrBuilder()

 The descriptor associated with this info.
 

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

getEndpointList

List<Flight.FlightEndpoint> getEndpointList()

 A list of endpoints associated with the flight. To consume the
 whole flight, all endpoints (and hence all Tickets) must be
 consumed. Endpoints can be consumed in any order.

 In other words, an application can use multiple endpoints to
 represent partitioned data.

 If the returned data has an ordering, an application can use
 "FlightInfo.ordered = true" or should return the all data in a
 single endpoint. Otherwise, there is no ordering defined on
 endpoints or the data within.

 A client can read ordered data by reading data from returned
 endpoints, in order, from front to back.

 Note that a client may ignore "FlightInfo.ordered = true". If an
 ordering is important for an application, an application must
 choose one of them:

 * An application requires that all clients must read data in
   returned endpoints order.
 * An application must return the all data in a single endpoint.
 

repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;

getEndpoint

Flight.FlightEndpoint getEndpoint(int index)

 A list of endpoints associated with the flight. To consume the
 whole flight, all endpoints (and hence all Tickets) must be
 consumed. Endpoints can be consumed in any order.

 In other words, an application can use multiple endpoints to
 represent partitioned data.

 If the returned data has an ordering, an application can use
 "FlightInfo.ordered = true" or should return the all data in a
 single endpoint. Otherwise, there is no ordering defined on
 endpoints or the data within.

 A client can read ordered data by reading data from returned
 endpoints, in order, from front to back.

 Note that a client may ignore "FlightInfo.ordered = true". If an
 ordering is important for an application, an application must
 choose one of them:

 * An application requires that all clients must read data in
   returned endpoints order.
 * An application must return the all data in a single endpoint.
 

repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;

getEndpointCount

int getEndpointCount()

 A list of endpoints associated with the flight. To consume the
 whole flight, all endpoints (and hence all Tickets) must be
 consumed. Endpoints can be consumed in any order.

 In other words, an application can use multiple endpoints to
 represent partitioned data.

 If the returned data has an ordering, an application can use
 "FlightInfo.ordered = true" or should return the all data in a
 single endpoint. Otherwise, there is no ordering defined on
 endpoints or the data within.

 A client can read ordered data by reading data from returned
 endpoints, in order, from front to back.

 Note that a client may ignore "FlightInfo.ordered = true". If an
 ordering is important for an application, an application must
 choose one of them:

 * An application requires that all clients must read data in
   returned endpoints order.
 * An application must return the all data in a single endpoint.
 

repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;

getEndpointOrBuilderList

List<? extends Flight.FlightEndpointOrBuilder> getEndpointOrBuilderList()

 A list of endpoints associated with the flight. To consume the
 whole flight, all endpoints (and hence all Tickets) must be
 consumed. Endpoints can be consumed in any order.

 In other words, an application can use multiple endpoints to
 represent partitioned data.

 If the returned data has an ordering, an application can use
 "FlightInfo.ordered = true" or should return the all data in a
 single endpoint. Otherwise, there is no ordering defined on
 endpoints or the data within.

 A client can read ordered data by reading data from returned
 endpoints, in order, from front to back.

 Note that a client may ignore "FlightInfo.ordered = true". If an
 ordering is important for an application, an application must
 choose one of them:

 * An application requires that all clients must read data in
   returned endpoints order.
 * An application must return the all data in a single endpoint.
 

repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;

getEndpointOrBuilder

Flight.FlightEndpointOrBuilder getEndpointOrBuilder(int index)

 A list of endpoints associated with the flight. To consume the
 whole flight, all endpoints (and hence all Tickets) must be
 consumed. Endpoints can be consumed in any order.

 In other words, an application can use multiple endpoints to
 represent partitioned data.

 If the returned data has an ordering, an application can use
 "FlightInfo.ordered = true" or should return the all data in a
 single endpoint. Otherwise, there is no ordering defined on
 endpoints or the data within.

 A client can read ordered data by reading data from returned
 endpoints, in order, from front to back.

 Note that a client may ignore "FlightInfo.ordered = true". If an
 ordering is important for an application, an application must
 choose one of them:

 * An application requires that all clients must read data in
   returned endpoints order.
 * An application must return the all data in a single endpoint.
 

repeated .arrow.flight.protocol.FlightEndpoint endpoint = 3;

getTotalRecords

long getTotalRecords()

 Set these to -1 if unknown.
 

int64 total_records = 4;

Returns:

The totalRecords.

getTotalBytes

long getTotalBytes()

int64 total_bytes = 5;

Returns:

The totalBytes.

getOrdered

boolean getOrdered()

 FlightEndpoints are in the same order as the data.
 

bool ordered = 6;

Returns:

The ordered.