org.apache.flink.runtime.jobmaster.slotpool

Enum LocationPreferenceSlotSelectionStrategy

java.lang.Object

java.lang.Enum<LocationPreferenceSlotSelectionStrategy>

org.apache.flink.runtime.jobmaster.slotpool.LocationPreferenceSlotSelectionStrategy

All Implemented Interfaces:

Serializable, Comparable<LocationPreferenceSlotSelectionStrategy>, SlotSelectionStrategy

public enum LocationPreferenceSlotSelectionStrategy
extends Enum<LocationPreferenceSlotSelectionStrategy>
implements SlotSelectionStrategy

This class implements a SlotSelectionStrategy that is based on location preference hints.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.jobmaster.slotpool.SlotSelectionStrategy

SlotSelectionStrategy.SlotInfoAndLocality

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
Optional<SlotSelectionStrategy.SlotInfoAndLocality>	selectBestSlotForProfile(Collection<? extends SlotInfo> availableSlots, SlotProfile slotProfile) Selects the best SlotInfo w.r.t.
static LocationPreferenceSlotSelectionStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocationPreferenceSlotSelectionStrategy[]	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

INSTANCE

public static final LocationPreferenceSlotSelectionStrategy INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

selectBestSlotForProfile

public Optional<SlotSelectionStrategy.SlotInfoAndLocality> selectBestSlotForProfile(@Nonnull
                                                                                    Collection<? extends SlotInfo> availableSlots,
                                                                                    @Nonnull
                                                                                    SlotProfile slotProfile)

Description copied from interface: SlotSelectionStrategy

Selects the best SlotInfo w.r.t. a certain selection criterion from the provided list of available slots and considering the given SlotProfile that describes the requirements.

Specified by:

selectBestSlotForProfile in interface SlotSelectionStrategy

Parameters:

availableSlots - a list of the available slots to select from.

slotProfile - a slot profile, describing requirements for the slot selection.

Returns:

the selected slot info with the corresponding locality hint.