Interface PollInfo

The information to process a long-running query.

Generated

from protobuf message arrow.flight.protocol.PollInfo

interface PollInfo {
    expirationTime?: Timestamp;
    flightDescriptor?: FlightDescriptor;
    info?: FlightInfo;
    progress?: number;
}

Properties

expirationTime? flightDescriptor? info? progress?

Properties

OptionalexpirationTime

expirationTime?: Timestamp

Expiration time for this request. After this passes, the server might not accept the retry descriptor anymore (and the query may be cancelled). This may be updated on a call to PollFlightInfo.

Generated

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

OptionalflightDescriptor

flightDescriptor?: FlightDescriptor

The descriptor the client should use on the next try. If unset, the query is complete.

Generated

from protobuf field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Optionalinfo

info?: FlightInfo

The currently available results.

If "flight_descriptor" is not specified, the query is complete and "info" specifies all results. Otherwise, "info" contains partial query results.

Note that each PollInfo response contains a complete FlightInfo (not just the delta between the previous and current FlightInfo).

Subsequent PollInfo responses may only append new endpoints to info.

Clients can begin fetching results via DoGet(Ticket) with the ticket in the info before the query is completed. FlightInfo.ordered is also valid.

Generated

from protobuf field: arrow.flight.protocol.FlightInfo info = 1;

Optionalprogress

progress?: number

Query progress. If known, must be in [0.0, 1.0] but need not be monotonic or nondecreasing. If unknown, do not set.

Generated

from protobuf field: optional double progress = 3;

Settings

Member Visibility

On This Page

Properties