org.apache.flink.runtime.jobmanager.scheduler

Enum Locality

java.lang.Object

java.lang.Enum<Locality>

org.apache.flink.runtime.jobmanager.scheduler.Locality

All Implemented Interfaces:

Serializable, Comparable<Locality>

public enum Locality
extends Enum<Locality>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOST_LOCAL The task was scheduled onto the same host as requested
LOCAL The task was scheduled into the same TaskManager as requested
NON_LOCAL The task was scheduled to a destination not included in its locality preferences.
UNCONSTRAINED No constraint existed on the task placement.
UNKNOWN No locality information was provided, it is unknown if the locality was respected

Method Summary

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

UNCONSTRAINED

public static final Locality UNCONSTRAINED

No constraint existed on the task placement.

LOCAL

public static final Locality LOCAL

The task was scheduled into the same TaskManager as requested

HOST_LOCAL

public static final Locality HOST_LOCAL

The task was scheduled onto the same host as requested

NON_LOCAL

public static final Locality NON_LOCAL

The task was scheduled to a destination not included in its locality preferences.

UNKNOWN

public static final Locality UNKNOWN

No locality information was provided, it is unknown if the locality was respected

Method Detail

values

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

Returns:

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

valueOf

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