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

Class Flight.FlightDescriptor

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

 The name or tag for a Flight. May be used as a way to retrieve or generate
 a flight or be used to expose a set of previously defined flights.
Protobuf type arrow.flight.protocol.FlightDescriptor
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Flight.FlightDescriptor.Builder
    The name or tag for a Flight.
    static enum 
    Flight.FlightDescriptor.DescriptorType
    Describes what type of descriptor is defined.

    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
    CMD_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    TYPE_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
    getCmd()
    Opaque value used to express a command.
    static Flight.FlightDescriptor
    getDefaultInstance()
     
    Flight.FlightDescriptor
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Flight.FlightDescriptor>
    getParserForType()
     
    String
    getPath(int index)
    List of strings identifying a particular dataset.
    com.google.protobuf.ByteString
    getPathBytes(int index)
    List of strings identifying a particular dataset.
    int
    getPathCount()
    List of strings identifying a particular dataset.
    com.google.protobuf.ProtocolStringList
    getPathList()
    List of strings identifying a particular dataset.
    int
    getSerializedSize()
     
    Flight.FlightDescriptor.DescriptorType
    getType()
    .arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
    int
    getTypeValue()
    .arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Flight.FlightDescriptor.Builder
    newBuilder()
     
    static Flight.FlightDescriptor.Builder
    newBuilder(Flight.FlightDescriptor prototype)
     
    Flight.FlightDescriptor.Builder
    newBuilderForType()
     
    protected Flight.FlightDescriptor.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Flight.FlightDescriptor
    parseDelimitedFrom(InputStream input)
     
    static Flight.FlightDescriptor
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightDescriptor
    parseFrom(byte[] data)
     
    static Flight.FlightDescriptor
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightDescriptor
    parseFrom(com.google.protobuf.ByteString data)
     
    static Flight.FlightDescriptor
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightDescriptor
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Flight.FlightDescriptor
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightDescriptor
    parseFrom(InputStream input)
     
    static Flight.FlightDescriptor
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Flight.FlightDescriptor
    parseFrom(ByteBuffer data)
     
    static Flight.FlightDescriptor
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Flight.FlightDescriptor>
    parser()
     
    Flight.FlightDescriptor.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

  • 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

    • getTypeValue

      public int getTypeValue()
      .arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
      Specified by:
      getTypeValue in interface Flight.FlightDescriptorOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public Flight.FlightDescriptor.DescriptorType getType()
      .arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
      Specified by:
      getType in interface Flight.FlightDescriptorOrBuilder
      Returns:
      The type.

    • getCmd

      public com.google.protobuf.ByteString getCmd()
      
 Opaque value used to express a command. Should only be defined when
 type = CMD.
      bytes cmd = 2;
      Specified by:
      getCmd in interface Flight.FlightDescriptorOrBuilder
      Returns:
      The cmd.

    • getPathList

      public com.google.protobuf.ProtocolStringList getPathList()
      
 List of strings identifying a particular dataset. Should only be defined
 when type = PATH.
      repeated string path = 3;
      Specified by:
      getPathList in interface Flight.FlightDescriptorOrBuilder
      Returns:
      A list containing the path.

    • getPathCount

      public int getPathCount()
      
 List of strings identifying a particular dataset. Should only be defined
 when type = PATH.
      repeated string path = 3;
      Specified by:
      getPathCount in interface Flight.FlightDescriptorOrBuilder
      Returns:
      The count of path.

    • getPath

      public String getPath(int index)
      
 List of strings identifying a particular dataset. Should only be defined
 when type = PATH.
      repeated string path = 3;
      Specified by:
      getPath in interface Flight.FlightDescriptorOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The path at the given index.

    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes(int index)
      
 List of strings identifying a particular dataset. Should only be defined
 when type = PATH.
      repeated string path = 3;
      Specified by:
      getPathBytes in interface Flight.FlightDescriptorOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the path at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Flight.FlightDescriptor.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Flight.FlightDescriptor getDefaultInstance()

    • parser

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

    • getParserForType

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