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

Class Flight.FlightData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.apache.arrow.flight.impl.Flight.FlightData
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Flight.FlightDataOrBuilder
Enclosing class:
Flight
public static final class Flight.FlightData extends com.google.protobuf.GeneratedMessage implements Flight.FlightDataOrBuilder

 A batch of Arrow data as part of a stream of batches.
Protobuf type arrow.flight.protocol.FlightData
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Flight.FlightData.Builder
    A batch of Arrow data as part of a stream of batches.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    APP_METADATA_FIELD_NUMBER
     
    static final int
    DATA_BODY_FIELD_NUMBER
     
    static final int
    DATA_HEADER_FIELD_NUMBER
     
    static final int
    FLIGHT_DESCRIPTOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.ByteString
    getAppMetadata()
    Application-defined metadata.
    com.google.protobuf.ByteString
    getDataBody()
    The actual batch of Arrow data.
    com.google.protobuf.ByteString
    getDataHeader()
    Header for message data as described in Message.fbs::Message.
    static Flight.FlightData
    getDefaultInstance()
     
    Flight.FlightData
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Flight.FlightDescriptor
    getFlightDescriptor()
    The descriptor of the data.
    Flight.FlightDescriptorOrBuilder
    getFlightDescriptorOrBuilder()
    The descriptor of the data.
    com.google.protobuf.Parser<Flight.FlightData>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasFlightDescriptor()
    The descriptor of the data.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Flight.FlightData.Builder
    newBuilder()
     
    static Flight.FlightData.Builder
    newBuilder(Flight.FlightData prototype)
     
    Flight.FlightData.Builder
    newBuilderForType()
     
    protected Flight.FlightData.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Flight.FlightData
    parseDelimitedFrom(InputStream input)
     
    static Flight.FlightData
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightData
    parseFrom(byte[] data)
     
    static Flight.FlightData
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightData
    parseFrom(com.google.protobuf.ByteString data)
     
    static Flight.FlightData
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightData
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Flight.FlightData
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightData
    parseFrom(InputStream input)
     
    static Flight.FlightData
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightData
    parseFrom(ByteBuffer data)
     
    static Flight.FlightData
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Flight.FlightData>
    parser()
     
    Flight.FlightData.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

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

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • FLIGHT_DESCRIPTOR_FIELD_NUMBER

      public static final int FLIGHT_DESCRIPTOR_FIELD_NUMBER
      See Also:

    • DATA_HEADER_FIELD_NUMBER

      public static final int DATA_HEADER_FIELD_NUMBER
      See Also:

    • APP_METADATA_FIELD_NUMBER

      public static final int APP_METADATA_FIELD_NUMBER
      See Also:

    • DATA_BODY_FIELD_NUMBER

      public static final int DATA_BODY_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

    • hasFlightDescriptor

      public boolean hasFlightDescriptor()
      
 The descriptor of the data. This is only relevant when a client is
 starting a new DoPut stream.
      .arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;
      Specified by:
      hasFlightDescriptor in interface Flight.FlightDataOrBuilder
      Returns:
      Whether the flightDescriptor field is set.

    • getFlightDescriptor

      public Flight.FlightDescriptor getFlightDescriptor()
      
 The descriptor of the data. This is only relevant when a client is
 starting a new DoPut stream.
      .arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;
      Specified by:
      getFlightDescriptor in interface Flight.FlightDataOrBuilder
      Returns:
      The flightDescriptor.

    • getFlightDescriptorOrBuilder

      public Flight.FlightDescriptorOrBuilder getFlightDescriptorOrBuilder()
      
 The descriptor of the data. This is only relevant when a client is
 starting a new DoPut stream.
      .arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;
      Specified by:
      getFlightDescriptorOrBuilder in interface Flight.FlightDataOrBuilder

    • getDataHeader

      public com.google.protobuf.ByteString getDataHeader()
      
 Header for message data as described in Message.fbs::Message.
      bytes data_header = 2;
      Specified by:
      getDataHeader in interface Flight.FlightDataOrBuilder
      Returns:
      The dataHeader.

    • getAppMetadata

      public com.google.protobuf.ByteString getAppMetadata()
      
 Application-defined metadata.
      bytes app_metadata = 3;
      Specified by:
      getAppMetadata in interface Flight.FlightDataOrBuilder
      Returns:
      The appMetadata.

    • getDataBody

      public com.google.protobuf.ByteString getDataBody()
      
 The actual batch of Arrow data. Preferably handled with minimal-copies
 coming last in the definition to help with sidecar patterns (it is
 expected that some implementations will fetch this field off the wire
 with specialized code to avoid extra memory copies).
      bytes data_body = 1000;
      Specified by:
      getDataBody in interface Flight.FlightDataOrBuilder
      Returns:
      The dataBody.

    • 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.FlightData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Flight.FlightData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Flight.FlightData 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.FlightData parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Flight.FlightData parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Flight.FlightData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Flight.FlightData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public Flight.FlightData.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Flight.FlightData.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public Flight.FlightData.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Flight.FlightData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Flight.FlightData getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Flight.FlightData> 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.FlightData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder