org.apache.arrow.flight.impl

Enum Flight.CancelStatus

java.lang.Object

java.lang.Enum<Flight.CancelStatus>

org.apache.arrow.flight.impl.Flight.CancelStatus

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Flight.CancelStatus>

Enclosing class:

Flight

public static enum Flight.CancelStatus
extends Enum<Flight.CancelStatus>
implements com.google.protobuf.ProtocolMessageEnum

 The result of a cancel operation.

 This is used by CancelFlightInfoResult.status.
 

Protobuf enum arrow.flight.protocol.CancelStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCEL_STATUS_CANCELLED The cancellation request is complete.
CANCEL_STATUS_CANCELLING The cancellation request is in progress.
CANCEL_STATUS_NOT_CANCELLABLE The query is not cancellable.
CANCEL_STATUS_UNSPECIFIED The cancellation status is unknown.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL_STATUS_CANCELLED_VALUE The cancellation request is complete.
static int	CANCEL_STATUS_CANCELLING_VALUE The cancellation request is in progress.
static int	CANCEL_STATUS_NOT_CANCELLABLE_VALUE The query is not cancellable.
static int	CANCEL_STATUS_UNSPECIFIED_VALUE The cancellation status is unknown.

Method Summary

Modifier and Type	Method and Description
static Flight.CancelStatus	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Flight.CancelStatus>	internalGetValueMap()
static Flight.CancelStatus	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Flight.CancelStatus	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Flight.CancelStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static Flight.CancelStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCEL_STATUS_UNSPECIFIED

public static final Flight.CancelStatus CANCEL_STATUS_UNSPECIFIED

 The cancellation status is unknown. Servers should avoid using
 this value (send a NOT_FOUND error if the requested query is
 not known). Clients can retry the request.
 

CANCEL_STATUS_UNSPECIFIED = 0;

CANCEL_STATUS_CANCELLED

public static final Flight.CancelStatus CANCEL_STATUS_CANCELLED

 The cancellation request is complete. Subsequent requests with
 the same payload may return CANCELLED or a NOT_FOUND error.
 

CANCEL_STATUS_CANCELLED = 1;

CANCEL_STATUS_CANCELLING

public static final Flight.CancelStatus CANCEL_STATUS_CANCELLING

 The cancellation request is in progress. The client may retry
 the cancellation request.
 

CANCEL_STATUS_CANCELLING = 2;

CANCEL_STATUS_NOT_CANCELLABLE

public static final Flight.CancelStatus CANCEL_STATUS_NOT_CANCELLABLE

 The query is not cancellable. The client should not retry the
 cancellation request.
 

CANCEL_STATUS_NOT_CANCELLABLE = 3;

UNRECOGNIZED

public static final Flight.CancelStatus UNRECOGNIZED

Field Detail

CANCEL_STATUS_UNSPECIFIED_VALUE

public static final int CANCEL_STATUS_UNSPECIFIED_VALUE

 The cancellation status is unknown. Servers should avoid using
 this value (send a NOT_FOUND error if the requested query is
 not known). Clients can retry the request.
 

CANCEL_STATUS_UNSPECIFIED = 0;

See Also:

Constant Field Values

CANCEL_STATUS_CANCELLED_VALUE

public static final int CANCEL_STATUS_CANCELLED_VALUE

 The cancellation request is complete. Subsequent requests with
 the same payload may return CANCELLED or a NOT_FOUND error.
 

CANCEL_STATUS_CANCELLED = 1;

See Also:

Constant Field Values

CANCEL_STATUS_CANCELLING_VALUE

public static final int CANCEL_STATUS_CANCELLING_VALUE

 The cancellation request is in progress. The client may retry
 the cancellation request.
 

CANCEL_STATUS_CANCELLING = 2;

See Also:

Constant Field Values

CANCEL_STATUS_NOT_CANCELLABLE_VALUE

public static final int CANCEL_STATUS_NOT_CANCELLABLE_VALUE

 The query is not cancellable. The client should not retry the
 cancellation request.
 

CANCEL_STATUS_NOT_CANCELLABLE = 3;

See Also:

Constant Field Values

Method Detail

values

public static Flight.CancelStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Flight.CancelStatus c : Flight.CancelStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Flight.CancelStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Flight.CancelStatus valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static Flight.CancelStatus forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Flight.CancelStatus> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

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

valueOf

public static Flight.CancelStatus valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)