org.apache.flink.runtime.clusterframework.types

Class SlotProfile

java.lang.Object

org.apache.flink.runtime.clusterframework.types.SlotProfile

public class SlotProfile
extends Object

A slot profile describes the profile of a slot into which a task wants to be scheduled. The profile contains attributes such as resource or locality constraints, some of which may be hard or soft. A matcher can be generated to filter out candidate slots by matching their SlotContext against the slot profile and, potentially, further requirements.

Constructor Summary

Constructors

Constructor and Description
SlotProfile(ResourceProfile resourceProfile, Collection<TaskManagerLocation> preferredLocations, Collection<AllocationID> priorAllocations)

Method Summary

Modifier and Type	Method and Description
Collection<TaskManagerLocation>	getPreferredLocations() Returns the preferred locations for the slot.
Collection<AllocationID>	getPriorAllocations() Returns the desired allocation ids for the slot.
ResourceProfile	getResourceProfile() Returns the desired resource profile for the slot.
static SlotProfile	noLocality(ResourceProfile resourceProfile) Returns a slot profile for the given resource profile, without any locality requirements.
static SlotProfile	noRequirements() Returns a slot profile that has no requirements.
static SlotProfile	preferredLocality(ResourceProfile resourceProfile, Collection<TaskManagerLocation> preferredLocations) Returns a slot profile for the given resource profile and the preferred locations.
static SlotProfile	priorAllocation(ResourceProfile resourceProfile, Collection<AllocationID> priorAllocations) Returns a slot profile for the given resource profile and the prior allocations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SlotProfile

public SlotProfile(@Nonnull
                   ResourceProfile resourceProfile,
                   @Nonnull
                   Collection<TaskManagerLocation> preferredLocations,
                   @Nonnull
                   Collection<AllocationID> priorAllocations)

Method Detail

getResourceProfile

@Nonnull
public ResourceProfile getResourceProfile()

Returns the desired resource profile for the slot.

getPreferredLocations

@Nonnull
public Collection<TaskManagerLocation> getPreferredLocations()

Returns the preferred locations for the slot.

getPriorAllocations

@Nonnull
public Collection<AllocationID> getPriorAllocations()

Returns the desired allocation ids for the slot.

noRequirements

public static SlotProfile noRequirements()

Returns a slot profile that has no requirements.

noLocality

public static SlotProfile noLocality(ResourceProfile resourceProfile)

Returns a slot profile for the given resource profile, without any locality requirements.

preferredLocality

public static SlotProfile preferredLocality(ResourceProfile resourceProfile,
                                            Collection<TaskManagerLocation> preferredLocations)

Returns a slot profile for the given resource profile and the preferred locations.

Parameters:

resourceProfile - specifying the slot requirements

preferredLocations - specifying the preferred locations

Returns:

Slot profile with the given resource profile and preferred locations

priorAllocation

public static SlotProfile priorAllocation(ResourceProfile resourceProfile,
                                          Collection<AllocationID> priorAllocations)

Returns a slot profile for the given resource profile and the prior allocations.

Parameters:

resourceProfile - specifying the slot requirements

priorAllocations - specifying the prior allocations

Returns:

Slot profile with the given resource profile and prior allocations