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

Class Flight.FlightEndpoint

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

 A particular stream or split associated with a flight.
Protobuf type arrow.flight.protocol.FlightEndpoint
See Also:

  • Field Details

    • TICKET_FIELD_NUMBER

      public static final int TICKET_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • EXPIRATION_TIME_FIELD_NUMBER

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

    • hasTicket

      public boolean hasTicket()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;
      Specified by:
      hasTicket in interface Flight.FlightEndpointOrBuilder
      Returns:
      Whether the ticket field is set.

    • getTicket

      public Flight.Ticket getTicket()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;
      Specified by:
      getTicket in interface Flight.FlightEndpointOrBuilder
      Returns:
      The ticket.

    • getTicketOrBuilder

      public Flight.TicketOrBuilder getTicketOrBuilder()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;
      Specified by:
      getTicketOrBuilder in interface Flight.FlightEndpointOrBuilder

    • getLocationList

      public List<Flight.Location> getLocationList()
      
 A list of URIs where this ticket can be redeemed via DoGet().

 If the list is empty, the expectation is that the ticket can only
 be redeemed on the current service where the ticket was
 generated.

 If the list is not empty, the expectation is that the ticket can be
 redeemed at any of the locations, and that the data returned will be
 equivalent. In this case, the ticket may only be redeemed at one of the
 given locations, and not (necessarily) on the current service. If one
 of the given locations is "arrow-flight-reuse-connection://?", the
 client may redeem the ticket on the service where the ticket was
 generated (i.e., the same as above), in addition to the other
 locations. (This URI was chosen to maximize compatibility, as 'scheme:'
 or 'scheme://' are not accepted by Java's java.net.URI.)

 In other words, an application can use multiple locations to
 represent redundant and/or load balanced services.
      repeated .arrow.flight.protocol.Location location = 2;
      Specified by:
      getLocationList in interface Flight.FlightEndpointOrBuilder

    • getLocationOrBuilderList

      public List<? extends Flight.LocationOrBuilder> getLocationOrBuilderList()
      
 A list of URIs where this ticket can be redeemed via DoGet().

 If the list is empty, the expectation is that the ticket can only
 be redeemed on the current service where the ticket was
 generated.

 If the list is not empty, the expectation is that the ticket can be
 redeemed at any of the locations, and that the data returned will be
 equivalent. In this case, the ticket may only be redeemed at one of the
 given locations, and not (necessarily) on the current service. If one
 of the given locations is "arrow-flight-reuse-connection://?", the
 client may redeem the ticket on the service where the ticket was
 generated (i.e., the same as above), in addition to the other
 locations. (This URI was chosen to maximize compatibility, as 'scheme:'
 or 'scheme://' are not accepted by Java's java.net.URI.)

 In other words, an application can use multiple locations to
 represent redundant and/or load balanced services.
      repeated .arrow.flight.protocol.Location location = 2;
      Specified by:
      getLocationOrBuilderList in interface Flight.FlightEndpointOrBuilder

    • getLocationCount

      public int getLocationCount()
      
 A list of URIs where this ticket can be redeemed via DoGet().

 If the list is empty, the expectation is that the ticket can only
 be redeemed on the current service where the ticket was
 generated.

 If the list is not empty, the expectation is that the ticket can be
 redeemed at any of the locations, and that the data returned will be
 equivalent. In this case, the ticket may only be redeemed at one of the
 given locations, and not (necessarily) on the current service. If one
 of the given locations is "arrow-flight-reuse-connection://?", the
 client may redeem the ticket on the service where the ticket was
 generated (i.e., the same as above), in addition to the other
 locations. (This URI was chosen to maximize compatibility, as 'scheme:'
 or 'scheme://' are not accepted by Java's java.net.URI.)

 In other words, an application can use multiple locations to
 represent redundant and/or load balanced services.
      repeated .arrow.flight.protocol.Location location = 2;
      Specified by:
      getLocationCount in interface Flight.FlightEndpointOrBuilder

    • getLocation

      public Flight.Location getLocation(int index)
      
 A list of URIs where this ticket can be redeemed via DoGet().

 If the list is empty, the expectation is that the ticket can only
 be redeemed on the current service where the ticket was
 generated.

 If the list is not empty, the expectation is that the ticket can be
 redeemed at any of the locations, and that the data returned will be
 equivalent. In this case, the ticket may only be redeemed at one of the
 given locations, and not (necessarily) on the current service. If one
 of the given locations is "arrow-flight-reuse-connection://?", the
 client may redeem the ticket on the service where the ticket was
 generated (i.e., the same as above), in addition to the other
 locations. (This URI was chosen to maximize compatibility, as 'scheme:'
 or 'scheme://' are not accepted by Java's java.net.URI.)

 In other words, an application can use multiple locations to
 represent redundant and/or load balanced services.
      repeated .arrow.flight.protocol.Location location = 2;
      Specified by:
      getLocation in interface Flight.FlightEndpointOrBuilder

    • getLocationOrBuilder

      public Flight.LocationOrBuilder getLocationOrBuilder(int index)
      
 A list of URIs where this ticket can be redeemed via DoGet().

 If the list is empty, the expectation is that the ticket can only
 be redeemed on the current service where the ticket was
 generated.

 If the list is not empty, the expectation is that the ticket can be
 redeemed at any of the locations, and that the data returned will be
 equivalent. In this case, the ticket may only be redeemed at one of the
 given locations, and not (necessarily) on the current service. If one
 of the given locations is "arrow-flight-reuse-connection://?", the
 client may redeem the ticket on the service where the ticket was
 generated (i.e., the same as above), in addition to the other
 locations. (This URI was chosen to maximize compatibility, as 'scheme:'
 or 'scheme://' are not accepted by Java's java.net.URI.)

 In other words, an application can use multiple locations to
 represent redundant and/or load balanced services.
      repeated .arrow.flight.protocol.Location location = 2;
      Specified by:
      getLocationOrBuilder in interface Flight.FlightEndpointOrBuilder

    • hasExpirationTime

      public boolean hasExpirationTime()
      
 Expiration time of this stream. If present, clients may assume
 they can retry DoGet requests. Otherwise, it is
 application-defined whether DoGet requests may be retried.
      .google.protobuf.Timestamp expiration_time = 3;
      Specified by:
      hasExpirationTime in interface Flight.FlightEndpointOrBuilder
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      public com.google.protobuf.Timestamp getExpirationTime()
      
 Expiration time of this stream. If present, clients may assume
 they can retry DoGet requests. Otherwise, it is
 application-defined whether DoGet requests may be retried.
      .google.protobuf.Timestamp expiration_time = 3;
      Specified by:
      getExpirationTime in interface Flight.FlightEndpointOrBuilder
      Returns:
      The expirationTime.

    • getExpirationTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()
      
 Expiration time of this stream. If present, clients may assume
 they can retry DoGet requests. Otherwise, it is
 application-defined whether DoGet requests may be retried.
      .google.protobuf.Timestamp expiration_time = 3;
      Specified by:
      getExpirationTimeOrBuilder in interface Flight.FlightEndpointOrBuilder

    • 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 FlightInfo 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 = 4;
      Specified by:
      getAppMetadata in interface Flight.FlightEndpointOrBuilder
      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.FlightEndpoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Flight.FlightEndpoint.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Flight.FlightEndpoint getDefaultInstance()

    • parser

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

    • getParserForType

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