Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class PollInfo

java.lang.Object

org.apache.arrow.flight.PollInfo

public class PollInfo
extends Object

A POJO representation of the execution of a long-running query.

Constructor Summary

Constructors

Constructor	Description
PollInfo(FlightInfo flightInfo, FlightDescriptor flightDescriptor, Double progress, Instant expirationTime)	Create a new PollInfo.

Method Summary

Modifier and Type	Method	Description
static PollInfo	deserialize(ByteBuffer serialized)
boolean	equals(Object o)
Optional<Instant>	getExpirationTime()	The expiration time of the query execution.
Optional<FlightDescriptor>	getFlightDescriptor()	The FlightDescriptor that should be used to get further updates on this query.
FlightInfo	getFlightInfo()	The FlightInfo describing the result set of the execution of a query.
Optional<Double>	getProgress()	The progress of the query.
int	hashCode()
ByteBuffer	serialize()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PollInfo

public PollInfo(FlightInfo flightInfo,
 FlightDescriptor flightDescriptor,
 Double progress,
 Instant expirationTime)

Create a new PollInfo.

Parameters:

flightInfo - The FlightInfo (must not be null).

flightDescriptor - The descriptor used to poll for more information; null if and only if query is finished.

progress - Optional progress info in [0.0, 1.0].

expirationTime - An expiration time, after which the server may no longer recognize the descriptor.

Method Details

getFlightInfo

public FlightInfo getFlightInfo()

The FlightInfo describing the result set of the execution of a query.

This is always present and always contains all endpoints for the query execution so far, not just new endpoints that completed execution since the last call to FlightClient.pollInfo(FlightDescriptor, CallOption...).

getFlightDescriptor

public Optional<FlightDescriptor> getFlightDescriptor()

The FlightDescriptor that should be used to get further updates on this query.

It is present if and only if the query is still running. If present, it should be passed to FlightClient.pollInfo(FlightDescriptor, CallOption...) to get an update.

getProgress

public Optional<Double> getProgress()

The progress of the query.

If present, should be a value in [0.0, 1.0]. It is not necessarily monotonic or non-decreasing.

getExpirationTime

public Optional<Instant> getExpirationTime()

The expiration time of the query execution.

After this passes, the server may not recognize the descriptor anymore and the client will not be able to track the query anymore.

serialize

public ByteBuffer serialize()

deserialize

public static PollInfo deserialize(ByteBuffer serialized)
                            throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object