Module org.apache.arrow.flight.core
Package org.apache.arrow.flight.impl

Class Flight.FlightInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage 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:

  • Field Details

    • SCHEMA_FIELD_NUMBER

      public static final int SCHEMA_FIELD_NUMBER
      See Also:

    • FLIGHT_DESCRIPTOR_FIELD_NUMBER

      public static final int FLIGHT_DESCRIPTOR_FIELD_NUMBER
      See Also:

    • ENDPOINT_FIELD_NUMBER

      public static final int ENDPOINT_FIELD_NUMBER
      See Also:

    • TOTAL_RECORDS_FIELD_NUMBER

      public static final int TOTAL_RECORDS_FIELD_NUMBER
      See Also:

    • TOTAL_BYTES_FIELD_NUMBER

      public static final int TOTAL_BYTES_FIELD_NUMBER
      See Also:

    • ORDERED_FIELD_NUMBER

      public static final int ORDERED_FIELD_NUMBER
      See Also:

    • APP_METADATA_FIELD_NUMBER

      public static final int APP_METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

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

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

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

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

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

    • getOrdered

      public boolean getOrdered()
      
 FlightEndpoints are in the same order as the data.
      bool ordered = 6;
      Specified by:
      getOrdered in interface Flight.FlightInfoOrBuilder
      Returns:
      The ordered.

    • getAppMetadata

      public 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;
      Specified by:
      getAppMetadata in interface Flight.FlightInfoOrBuilder
      Returns:
      The appMetadata.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public Flight.FlightInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder