org.apache.arrow.flight

Enum CancelStatus

java.lang.Object

java.lang.Enum<CancelStatus>

org.apache.arrow.flight.CancelStatus

All Implemented Interfaces:

Serializable, Comparable<CancelStatus>

public enum CancelStatus
extends Enum<CancelStatus>

The result of cancelling a FlightInfo.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED The cancellation request is complete.
CANCELLING The cancellation request is in progress.
NOT_CANCELLABLE The query is not cancellable.
UNSPECIFIED The cancellation status is unknown.

Method Summary

Modifier and Type	Method and Description
static CancelStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

UNSPECIFIED

public static final CancelStatus 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.

CANCELLED

public static final CancelStatus CANCELLED

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

CANCELLING

public static final CancelStatus CANCELLING

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

NOT_CANCELLABLE

public static final CancelStatus NOT_CANCELLABLE

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

Method Detail

values

public static 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 (CancelStatus c : 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 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