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| Modifier and Type | Class and Description |
|---|---|
static class |
Flight.FlightInfo.Builder
The access coordinates for retrieval of a dataset.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
APP_METADATA_FIELD_NUMBER |
static int |
ENDPOINT_FIELD_NUMBER |
static int |
FLIGHT_DESCRIPTOR_FIELD_NUMBER |
static int |
ORDERED_FIELD_NUMBER |
static int |
SCHEMA_FIELD_NUMBER |
static int |
TOTAL_BYTES_FIELD_NUMBER |
static int |
TOTAL_RECORDS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
com.google.protobuf.ByteString |
getAppMetadata()
Application-defined metadata.
|
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.
|
boolean |
getOrdered()
FlightEndpoints are in the same order as the data.
|
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.
|
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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SCHEMA_FIELD_NUMBER
public static final int FLIGHT_DESCRIPTOR_FIELD_NUMBER
public static final int ENDPOINT_FIELD_NUMBER
public static final int TOTAL_RECORDS_FIELD_NUMBER
public static final int TOTAL_BYTES_FIELD_NUMBER
public static final int ORDERED_FIELD_NUMBER
public static final int APP_METADATA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;getSchema in interface Flight.FlightInfoOrBuilderpublic boolean hasFlightDescriptor()
The descriptor associated with this info.
.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;hasFlightDescriptor in interface Flight.FlightInfoOrBuilderpublic Flight.FlightDescriptor getFlightDescriptor()
The descriptor associated with this info.
.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;getFlightDescriptor in interface Flight.FlightInfoOrBuilderpublic Flight.FlightDescriptorOrBuilder getFlightDescriptorOrBuilder()
The descriptor associated with this info.
.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;getFlightDescriptorOrBuilder in interface Flight.FlightInfoOrBuilderpublic 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;getEndpointList in interface Flight.FlightInfoOrBuilderpublic 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;getEndpointOrBuilderList in interface Flight.FlightInfoOrBuilderpublic 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;getEndpointCount in interface Flight.FlightInfoOrBuilderpublic 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;getEndpoint in interface Flight.FlightInfoOrBuilderpublic 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;getEndpointOrBuilder in interface Flight.FlightInfoOrBuilderpublic long getTotalRecords()
Set these to -1 if unknown.
int64 total_records = 4;getTotalRecords in interface Flight.FlightInfoOrBuilderpublic long getTotalBytes()
int64 total_bytes = 5;getTotalBytes in interface Flight.FlightInfoOrBuilderpublic boolean getOrdered()
FlightEndpoints are in the same order as the data.
bool ordered = 6;getOrdered in interface Flight.FlightInfoOrBuilderpublic com.google.protobuf.ByteString getAppMetadata()
Application-defined metadata. There is no inherent or required relationship between this and the app_metadata fields in the FlightEndpoints or resulting FlightData messages. Since this metadata is application-defined, a given application could define there to be a relationship, but there is none required by the spec.
bytes app_metadata = 7;getAppMetadata in interface Flight.FlightInfoOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Flight.FlightInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Flight.FlightInfo parseFrom(InputStream input) throws IOException
IOExceptionpublic static Flight.FlightInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Flight.FlightInfo parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Flight.FlightInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Flight.FlightInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Flight.FlightInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Flight.FlightInfo.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Flight.FlightInfo.Builder newBuilder()
public static Flight.FlightInfo.Builder newBuilder(Flight.FlightInfo prototype)
public Flight.FlightInfo.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Flight.FlightInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Flight.FlightInfo getDefaultInstance()
public static com.google.protobuf.Parser<Flight.FlightInfo> parser()
public com.google.protobuf.Parser<Flight.FlightInfo> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Flight.FlightInfo getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 The Apache Software Foundation. All rights reserved.