A particular stream or split associated with a flight.

from protobuf message arrow.flight.protocol.FlightEndpoint

interface FlightEndpoint {
    appMetadata: Uint8Array;
    expirationTime?: Timestamp;
    location: Location[];
    ticket?: Ticket;
}

Properties

appMetadata: Uint8Array

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.

from protobuf field: bytes app_metadata = 4;

expirationTime?: Timestamp

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.

from protobuf field: google.protobuf.Timestamp expiration_time = 3;

location: Location[]

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.

In other words, an application can use multiple locations to represent redundant and/or load balanced services.

from protobuf field: repeated arrow.flight.protocol.Location location = 2;

ticket?: Ticket

Token used to retrieve this stream.

from protobuf field: arrow.flight.protocol.Ticket ticket = 1;