StopMode (Flink : Runtime 2.1.0 API)

java.lang.Object
- java.lang.Enum<StopMode>
- - org.apache.flink.runtime.io.network.api.StopMode

All Implemented Interfaces:

Serializable, Comparable<StopMode>
```
@Internal
public enum StopMode
extends Enum<StopMode>
```
Tells if the job is stopping because of consuming all data. DRAIN means the job is stopping either with a stop-with-savepoint --drain or due to consuming all records in the source. A drained pipeline should call StreamOperator#finish() on all operators.

Enum Constant Summary

Enum Constants
Enum Constant Description

DRAIN

NO_DRAIN

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static StopMode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static StopMode[]`	`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
  - DRAIN
```
public static final StopMode DRAIN
```
  - NO_DRAIN
```
public static final StopMode NO_DRAIN
```
- Method Detail
  - values
```
public static StopMode[] 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 (StopMode c : StopMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StopMode 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