org.apache.arrow.flight.impl

Class Flight.FlightInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.impl.Flight.FlightInfo

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Flight.FlightInfoOrBuilder

Enclosing class:

Flight

public static final class Flight.FlightInfo
extends com.google.protobuf.GeneratedMessageV3
implements Flight.FlightInfoOrBuilder

 The access coordinates for retrieval of a dataset. With a FlightInfo, a
 consumer is able to determine how to retrieve a dataset.
 

Protobuf type arrow.flight.protocol.FlightInfo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Flight.FlightInfo.Builder The access coordinates for retrieval of a dataset.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENDPOINT_FIELD_NUMBER
static int	FLIGHT_DESCRIPTOR_FIELD_NUMBER
static int	SCHEMA_FIELD_NUMBER
static int	TOTAL_BYTES_FIELD_NUMBER
static int	TOTAL_RECORDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Flight.FlightInfo	getDefaultInstance()
Flight.FlightInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Flight.FlightInfo>	getParserForType()
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
int	getSerializedSize()
long	getTotalBytes() int64 total_bytes = 5;
long	getTotalRecords() Set these to -1 if unknown.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFlightDescriptor() The descriptor associated with this info.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Flight.FlightInfo.Builder	newBuilder()
static Flight.FlightInfo.Builder	newBuilder(Flight.FlightInfo prototype)
Flight.FlightInfo.Builder	newBuilderForType()
protected Flight.FlightInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Flight.FlightInfo	parseDelimitedFrom(InputStream input)
static Flight.FlightInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.FlightInfo	parseFrom(byte[] data)
static Flight.FlightInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.FlightInfo	parseFrom(ByteBuffer data)
static Flight.FlightInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.FlightInfo	parseFrom(com.google.protobuf.ByteString data)
static Flight.FlightInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.FlightInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static Flight.FlightInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.FlightInfo	parseFrom(InputStream input)
static Flight.FlightInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Flight.FlightInfo>	parser()
Flight.FlightInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

FLIGHT_DESCRIPTOR_FIELD_NUMBER

public static final int FLIGHT_DESCRIPTOR_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_RECORDS_FIELD_NUMBER

public static final int TOTAL_RECORDS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_BYTES_FIELD_NUMBER

public static final int TOTAL_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSchema

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

Specified by:

getSchema in interface Flight.FlightInfoOrBuilder

Returns:

The schema.

hasFlightDescriptor

public boolean hasFlightDescriptor()

 The descriptor associated with this info.
 

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

Specified by:

hasFlightDescriptor in interface Flight.FlightInfoOrBuilder

Returns:

Whether the flightDescriptor field is set.

getFlightDescriptor

public Flight.FlightDescriptor getFlightDescriptor()

 The descriptor associated with this info.
 

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

Specified by:

getFlightDescriptor in interface Flight.FlightInfoOrBuilder

Returns:

The flightDescriptor.

getFlightDescriptorOrBuilder

public Flight.FlightDescriptorOrBuilder getFlightDescriptorOrBuilder()

 The descriptor associated with this info.
 

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

Specified by:

getFlightDescriptorOrBuilder in interface Flight.FlightInfoOrBuilder

getEndpointList

public 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.
 There is no ordering defined on endpoints. Hence, if the returned
 data has an ordering, it should be returned in a single endpoint.
 

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

Specified by:

getEndpointList in interface Flight.FlightInfoOrBuilder

getEndpointOrBuilderList

public 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.
 There is no ordering defined on endpoints. Hence, if the returned
 data has an ordering, it should be returned in a single endpoint.
 

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

Specified by:

getEndpointOrBuilderList in interface Flight.FlightInfoOrBuilder

getEndpointCount

public 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.
 There is no ordering defined on endpoints. Hence, if the returned
 data has an ordering, it should be returned in a single endpoint.
 

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

Specified by:

getEndpointCount in interface Flight.FlightInfoOrBuilder

getEndpoint

public 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.
 There is no ordering defined on endpoints. Hence, if the returned
 data has an ordering, it should be returned in a single endpoint.
 

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

Specified by:

getEndpoint in interface Flight.FlightInfoOrBuilder

getEndpointOrBuilder

public 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.
 There is no ordering defined on endpoints. Hence, if the returned
 data has an ordering, it should be returned in a single endpoint.
 

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

Specified by:

getEndpointOrBuilder in interface Flight.FlightInfoOrBuilder

getTotalRecords

public long getTotalRecords()

 Set these to -1 if unknown.
 

int64 total_records = 4;

Specified by:

getTotalRecords in interface Flight.FlightInfoOrBuilder

Returns:

The totalRecords.

getTotalBytes

public long getTotalBytes()

int64 total_bytes = 5;

Specified by:

getTotalBytes in interface Flight.FlightInfoOrBuilder

Returns:

The totalBytes.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Flight.FlightInfo parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.FlightInfo parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static Flight.FlightInfo parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Flight.FlightInfo parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Flight.FlightInfo parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static Flight.FlightInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static Flight.FlightInfo parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public Flight.FlightInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Flight.FlightInfo.Builder newBuilder()

newBuilder

public static Flight.FlightInfo.Builder newBuilder(Flight.FlightInfo prototype)

toBuilder

public Flight.FlightInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Flight.FlightInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Flight.FlightInfo getDefaultInstance()

parser

public static com.google.protobuf.Parser<Flight.FlightInfo> parser()

getParserForType

public com.google.protobuf.Parser<Flight.FlightInfo> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Flight.FlightInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder