org.apache.flink.streaming.runtime.io

Enum DataInputStatus

java.lang.Object

java.lang.Enum<DataInputStatus>

org.apache.flink.streaming.runtime.io.DataInputStatus

All Implemented Interfaces:

Serializable, Comparable<DataInputStatus>

@Internal
public enum DataInputStatus
extends Enum<DataInputStatus>

It is an internal equivalent of InputStatus that provides additional non public statuses.

An InputStatus indicates the availability of data from an asynchronous input. When asking an asynchronous input to produce data, it returns this status to indicate how to proceed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_OF_DATA Indicator that the input has reached the end of data.
END_OF_INPUT Indicator that the input has reached the end of data and control events.
END_OF_RECOVERY Indicator that all persisted data of the data exchange has been successfully restored.
MORE_AVAILABLE Indicator that more data is available and the input can be called immediately again to produce more data.
NOTHING_AVAILABLE Indicator that no data is currently available, but more data will be available in the future again.
STOPPED Indicator that the input was stopped because of stop-with-savepoint without drain.

Method Summary

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

MORE_AVAILABLE

public static final DataInputStatus MORE_AVAILABLE

Indicator that more data is available and the input can be called immediately again to produce more data.

NOTHING_AVAILABLE

public static final DataInputStatus NOTHING_AVAILABLE

Indicator that no data is currently available, but more data will be available in the future again.

END_OF_RECOVERY

public static final DataInputStatus END_OF_RECOVERY

Indicator that all persisted data of the data exchange has been successfully restored.

STOPPED

public static final DataInputStatus STOPPED

Indicator that the input was stopped because of stop-with-savepoint without drain.

END_OF_DATA

public static final DataInputStatus END_OF_DATA

Indicator that the input has reached the end of data.

END_OF_INPUT

public static final DataInputStatus END_OF_INPUT

Indicator that the input has reached the end of data and control events. The input is about to close.

Method Detail

values

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

Returns:

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

valueOf

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