Module org.apache.arrow.flight.core

Package org.apache.arrow.flight.impl

Class Flight.PollInfo.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Flight.PollInfoOrBuilder

Enclosing class:

Flight.PollInfo

public static final class Flight.PollInfo.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>
implements Flight.PollInfoOrBuilder

 The information to process a long-running query.
 

Protobuf type arrow.flight.protocol.PollInfo

Method Summary

Modifier and Type	Method	Description
Flight.PollInfo	build()
Flight.PollInfo	buildPartial()
Flight.PollInfo.Builder	clear()
Flight.PollInfo.Builder	clearExpirationTime()	Expiration time for this request.
Flight.PollInfo.Builder	clearFlightDescriptor()	The descriptor the client should use on the next try.
Flight.PollInfo.Builder	clearInfo()	The currently available results.
Flight.PollInfo.Builder	clearProgress()	Query progress.
Flight.PollInfo	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Timestamp	getExpirationTime()	Expiration time for this request.
com.google.protobuf.Timestamp.Builder	getExpirationTimeBuilder()	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.FlightDescriptor.Builder	getFlightDescriptorBuilder()	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.FlightInfo.Builder	getInfoBuilder()	The currently available results.
Flight.FlightInfoOrBuilder	getInfoOrBuilder()	The currently available results.
double	getProgress()	Query progress.
boolean	hasExpirationTime()	Expiration time for this request.
boolean	hasFlightDescriptor()	The descriptor the client should use on the next try.
boolean	hasInfo()	The currently available results.
boolean	hasProgress()	Query progress.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Flight.PollInfo.Builder	mergeExpirationTime(com.google.protobuf.Timestamp value)	Expiration time for this request.
Flight.PollInfo.Builder	mergeFlightDescriptor(Flight.FlightDescriptor value)	The descriptor the client should use on the next try.
Flight.PollInfo.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Flight.PollInfo.Builder	mergeFrom(com.google.protobuf.Message other)
Flight.PollInfo.Builder	mergeFrom(Flight.PollInfo other)
Flight.PollInfo.Builder	mergeInfo(Flight.FlightInfo value)	The currently available results.
Flight.PollInfo.Builder	setExpirationTime(com.google.protobuf.Timestamp value)	Expiration time for this request.
Flight.PollInfo.Builder	setExpirationTime(com.google.protobuf.Timestamp.Builder builderForValue)	Expiration time for this request.
Flight.PollInfo.Builder	setFlightDescriptor(Flight.FlightDescriptor value)	The descriptor the client should use on the next try.
Flight.PollInfo.Builder	setFlightDescriptor(Flight.FlightDescriptor.Builder builderForValue)	The descriptor the client should use on the next try.
Flight.PollInfo.Builder	setInfo(Flight.FlightInfo value)	The currently available results.
Flight.PollInfo.Builder	setInfo(Flight.FlightInfo.Builder builderForValue)	The currently available results.
Flight.PollInfo.Builder	setProgress(double value)	Query progress.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>

clear

public Flight.PollInfo.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>

getDefaultInstanceForType

public Flight.PollInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Flight.PollInfo build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Flight.PollInfo buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Flight.PollInfo.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Flight.PollInfo.Builder>

mergeFrom

public Flight.PollInfo.Builder mergeFrom(Flight.PollInfo other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Flight.PollInfo.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Flight.PollInfo.Builder>

Throws:

IOException

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.

setInfo

public Flight.PollInfo.Builder setInfo(Flight.FlightInfo value)

 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;

setInfo

public Flight.PollInfo.Builder setInfo(Flight.FlightInfo.Builder builderForValue)

 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;

mergeInfo

public Flight.PollInfo.Builder mergeInfo(Flight.FlightInfo value)

 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;

clearInfo

public Flight.PollInfo.Builder clearInfo()

 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;

getInfoBuilder

public Flight.FlightInfo.Builder getInfoBuilder()

 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;

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.

setFlightDescriptor

public Flight.PollInfo.Builder setFlightDescriptor(Flight.FlightDescriptor value)

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

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

setFlightDescriptor

public Flight.PollInfo.Builder setFlightDescriptor(Flight.FlightDescriptor.Builder builderForValue)

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

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

mergeFlightDescriptor

public Flight.PollInfo.Builder mergeFlightDescriptor(Flight.FlightDescriptor value)

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

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

clearFlightDescriptor

public Flight.PollInfo.Builder clearFlightDescriptor()

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

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

getFlightDescriptorBuilder

public Flight.FlightDescriptor.Builder getFlightDescriptorBuilder()

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

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

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.

setProgress

public Flight.PollInfo.Builder setProgress(double value)

 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;

Parameters:

value - The progress to set.

Returns:

This builder for chaining.

clearProgress

public Flight.PollInfo.Builder clearProgress()

 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;

Returns:

This builder for chaining.

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.

setExpirationTime

public Flight.PollInfo.Builder setExpirationTime(com.google.protobuf.Timestamp value)

 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;

setExpirationTime

public Flight.PollInfo.Builder setExpirationTime(com.google.protobuf.Timestamp.Builder builderForValue)

 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;

mergeExpirationTime

public Flight.PollInfo.Builder mergeExpirationTime(com.google.protobuf.Timestamp value)

 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;

clearExpirationTime

public Flight.PollInfo.Builder clearExpirationTime()

 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;

getExpirationTimeBuilder

public com.google.protobuf.Timestamp.Builder getExpirationTimeBuilder()

 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;

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