Package org.apache.arrow.flight.impl

Interface Flight.FlightEndpointOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Flight.FlightEndpoint, Flight.FlightEndpoint.Builder
Enclosing class:
Flight
public static interface Flight.FlightEndpointOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasTicket

      boolean hasTicket()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;
      Returns:
      Whether the ticket field is set.

    • getTicket

      Flight.Ticket getTicket()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;
      Returns:
      The ticket.

    • getTicketOrBuilder

      Flight.TicketOrBuilder getTicketOrBuilder()
      
 Token used to retrieve this stream.
      .arrow.flight.protocol.Ticket ticket = 1;

    • getLocationList

      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;

    • getLocation

      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;

    • getLocationCount

      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;

    • getLocationOrBuilderList

      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;

    • getLocationOrBuilder

      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;

    • hasExpirationTime

      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;
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      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;
      Returns:
      The expirationTime.

    • getExpirationTimeOrBuilder

      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;

    • getAppMetadata

      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;
      Returns:
      The appMetadata.