Package org.apache.flink.table.gateway.api.operation

Enum OperationStatus

java.lang.Object

java.lang.Enum<OperationStatus>

org.apache.flink.table.gateway.api.operation.OperationStatus

All Implemented Interfaces:

Serializable, Comparable<OperationStatus>

@PublicEvolving
public enum OperationStatus
extends Enum<OperationStatus>

Status to describe the Operation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELED	Operation has been cancelled.
CLOSED	Operation has been closed and all related resources are collected.
ERROR	Some error happens.
FINISHED	All the work is finished and ready for the client to fetch the results.
INITIALIZED	The operation is newly created.
PENDING	Prepare the resources for the operation.
RUNNING	The operation is running.
TIMEOUT	The execution of the operation timeout.

Method Summary

Modifier and Type	Method	Description
boolean	isTerminalStatus()
static boolean	isValidStatusTransition(OperationStatus fromStatus, OperationStatus toStatus)
static OperationStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OperationStatus[]	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

INITIALIZED

public static final OperationStatus INITIALIZED

The operation is newly created.

PENDING

public static final OperationStatus PENDING

Prepare the resources for the operation.

RUNNING

public static final OperationStatus RUNNING

The operation is running.

FINISHED

public static final OperationStatus FINISHED

All the work is finished and ready for the client to fetch the results.

CANCELED

public static final OperationStatus CANCELED

Operation has been cancelled.

CLOSED

public static final OperationStatus CLOSED

Operation has been closed and all related resources are collected.

ERROR

public static final OperationStatus ERROR

Some error happens.

TIMEOUT

public static final OperationStatus TIMEOUT

The execution of the operation timeout.

Method Detail

values

public static OperationStatus[] 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 (OperationStatus c : OperationStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static OperationStatus 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

isValidStatusTransition

public static boolean isValidStatusTransition(OperationStatus fromStatus,
                                              OperationStatus toStatus)

isTerminalStatus

public boolean isTerminalStatus()