org.apache.arrow.flight.impl

Class Flight.PollInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.impl.Flight.PollInfo

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Flight.PollInfoOrBuilder

Enclosing class:

Flight

public static final class Flight.PollInfo
extends com.google.protobuf.GeneratedMessageV3
implements Flight.PollInfoOrBuilder

 The information to process a long-running query.
 

Protobuf type arrow.flight.protocol.PollInfo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Flight.PollInfo.Builder The information to process a long-running query.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPIRATION_TIME_FIELD_NUMBER
static int	FLIGHT_DESCRIPTOR_FIELD_NUMBER
static int	INFO_FIELD_NUMBER
static int	PROGRESS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Flight.PollInfo	getDefaultInstance()
Flight.PollInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getExpirationTime() Expiration time for this request.
com.google.protobuf.TimestampOrBuilder	getExpirationTimeOrBuilder() Expiration time for this request.
Flight.FlightDescriptor	getFlightDescriptor() The descriptor the client should use on the next try.
Flight.FlightDescriptorOrBuilder	getFlightDescriptorOrBuilder() The descriptor the client should use on the next try.
Flight.FlightInfo	getInfo() The currently available results.
Flight.FlightInfoOrBuilder	getInfoOrBuilder() The currently available results.
com.google.protobuf.Parser<Flight.PollInfo>	getParserForType()
double	getProgress() Query progress.
int	getSerializedSize()
boolean	hasExpirationTime() Expiration time for this request.
boolean	hasFlightDescriptor() The descriptor the client should use on the next try.
int	hashCode()
boolean	hasInfo() The currently available results.
boolean	hasProgress() Query progress.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Flight.PollInfo.Builder	newBuilder()
static Flight.PollInfo.Builder	newBuilder(Flight.PollInfo prototype)
Flight.PollInfo.Builder	newBuilderForType()
protected Flight.PollInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Flight.PollInfo	parseDelimitedFrom(InputStream input)
static Flight.PollInfo	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.PollInfo	parseFrom(byte[] data)
static Flight.PollInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.PollInfo	parseFrom(ByteBuffer data)
static Flight.PollInfo	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.PollInfo	parseFrom(com.google.protobuf.ByteString data)
static Flight.PollInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.PollInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static Flight.PollInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.PollInfo	parseFrom(InputStream input)
static Flight.PollInfo	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Flight.PollInfo>	parser()
Flight.PollInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INFO_FIELD_NUMBER

public static final int INFO_FIELD_NUMBER

See Also:

Constant Field Values

FLIGHT_DESCRIPTOR_FIELD_NUMBER

public static final int FLIGHT_DESCRIPTOR_FIELD_NUMBER

See Also:

Constant Field Values

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRATION_TIME_FIELD_NUMBER

public static final int EXPIRATION_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasInfo

public boolean hasInfo()

 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.
 

.arrow.flight.protocol.FlightInfo info = 1;

Specified by:

hasInfo in interface Flight.PollInfoOrBuilder

Returns:

Whether the info field is set.

getInfo

public Flight.FlightInfo getInfo()

 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.
 

.arrow.flight.protocol.FlightInfo info = 1;

Specified by:

getInfo in interface Flight.PollInfoOrBuilder

Returns:

The info.

getInfoOrBuilder

public Flight.FlightInfoOrBuilder getInfoOrBuilder()

 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.
 

.arrow.flight.protocol.FlightInfo info = 1;

Specified by:

getInfoOrBuilder in interface Flight.PollInfoOrBuilder

hasFlightDescriptor

public boolean hasFlightDescriptor()

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

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Specified by:

hasFlightDescriptor in interface Flight.PollInfoOrBuilder

Returns:

Whether the flightDescriptor field is set.

getFlightDescriptor

public Flight.FlightDescriptor getFlightDescriptor()

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

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Specified by:

getFlightDescriptor in interface Flight.PollInfoOrBuilder

Returns:

The flightDescriptor.

getFlightDescriptorOrBuilder

public Flight.FlightDescriptorOrBuilder getFlightDescriptorOrBuilder()

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

.arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;

Specified by:

getFlightDescriptorOrBuilder in interface Flight.PollInfoOrBuilder

hasProgress

public boolean hasProgress()

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

optional double progress = 3;

Specified by:

hasProgress in interface Flight.PollInfoOrBuilder

Returns:

Whether the progress field is set.

getProgress

public double getProgress()

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

optional double progress = 3;

Specified by:

getProgress in interface Flight.PollInfoOrBuilder

Returns:

The progress.

hasExpirationTime

public boolean hasExpirationTime()

 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.
 

.google.protobuf.Timestamp expiration_time = 4;

Specified by:

hasExpirationTime in interface Flight.PollInfoOrBuilder

Returns:

Whether the expirationTime field is set.

getExpirationTime

public com.google.protobuf.Timestamp getExpirationTime()

 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.
 

.google.protobuf.Timestamp expiration_time = 4;

Specified by:

getExpirationTime in interface Flight.PollInfoOrBuilder

Returns:

The expirationTime.

getExpirationTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()

 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.
 

.google.protobuf.Timestamp expiration_time = 4;

Specified by:

getExpirationTimeOrBuilder in interface Flight.PollInfoOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.PollInfo parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.PollInfo parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.PollInfo parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Flight.PollInfo parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Flight.PollInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Flight.PollInfo.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Flight.PollInfo.Builder newBuilder()

newBuilder

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

toBuilder

public Flight.PollInfo.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Flight.PollInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Flight.PollInfo getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Flight.PollInfo> 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.GeneratedMessageV3

getDefaultInstanceForType

public Flight.PollInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder