org.apache.flink.runtime.jobmaster.slotpool

Interface SlotPool

All Superinterfaces:

AllocatedSlotActions, AutoCloseable

All Known Implementing Classes:

SlotPoolImpl

public interface SlotPool
extends AllocatedSlotActions, AutoCloseable

The Interface of a slot pool that manages slots.

Method Summary

Modifier and Type	Method and Description
Optional<PhysicalSlot>	allocateAvailableSlot(SlotRequestId slotRequestId, AllocationID allocationID) Allocates the available slot with the given allocation id under the given request id.
void	close()
void	connectToResourceManager(ResourceManagerGateway resourceManagerGateway) Connects the SlotPool to the given ResourceManager.
AllocatedSlotReport	createAllocatedSlotReport(ResourceID taskManagerId) Create report about the allocated slots belonging to the specified task manager.
void	disconnectResourceManager() Disconnects the slot pool from its current Resource Manager.
Optional<ResourceID>	failAllocation(AllocationID allocationID, Exception cause) Fails the slot with the given allocation id.
Collection<SlotInfoWithUtilization>	getAvailableSlotsInformation() Returns a list of SlotInfoWithUtilization objects about all slots that are currently available in the slot pool.
Collection<SlotOffer>	offerSlots(TaskManagerLocation taskManagerLocation, TaskManagerGateway taskManagerGateway, Collection<SlotOffer> offers) Offers multiple slots to the SlotPool.
boolean	registerTaskManager(ResourceID resourceID) Registers a TaskExecutor with the given ResourceID at SlotPool.
boolean	releaseTaskManager(ResourceID resourceId, Exception cause) Releases a TaskExecutor with the given ResourceID from the SlotPool.
CompletableFuture<PhysicalSlot>	requestNewAllocatedBatchSlot(SlotRequestId slotRequestId, ResourceProfile resourceProfile) Requests the allocation of a new batch slot from the resource manager.
CompletableFuture<PhysicalSlot>	requestNewAllocatedSlot(SlotRequestId slotRequestId, ResourceProfile resourceProfile, org.apache.flink.api.common.time.Time timeout) Request the allocation of a new slot from the resource manager.
void	start(JobMasterId jobMasterId, String newJobManagerAddress, ComponentMainThreadExecutor jmMainThreadScheduledExecutor)
void	suspend()

Methods inherited from interface org.apache.flink.runtime.jobmaster.slotpool.AllocatedSlotActions

releaseSlot

Method Detail

start

void start(JobMasterId jobMasterId,
           String newJobManagerAddress,
           ComponentMainThreadExecutor jmMainThreadScheduledExecutor)
    throws Exception

Throws:

Exception

suspend

void suspend()

close

void close()

Specified by:

close in interface AutoCloseable

connectToResourceManager

void connectToResourceManager(ResourceManagerGateway resourceManagerGateway)

Connects the SlotPool to the given ResourceManager. After this method is called, the SlotPool will be able to request resources from the given ResourceManager.

Parameters:

resourceManagerGateway - The RPC gateway for the resource manager.

disconnectResourceManager

void disconnectResourceManager()

Disconnects the slot pool from its current Resource Manager. After this call, the pool will not be able to request further slots from the Resource Manager, and all currently pending requests to the resource manager will be canceled.

The slot pool will still be able to serve slots from its internal pool.

registerTaskManager

boolean registerTaskManager(ResourceID resourceID)

Registers a TaskExecutor with the given ResourceID at SlotPool.

Parameters:

resourceID - identifying the TaskExecutor to register

Returns:

true iff a new resource id was registered

releaseTaskManager

boolean releaseTaskManager(ResourceID resourceId,
                           Exception cause)

Releases a TaskExecutor with the given ResourceID from the SlotPool.

Parameters:

resourceId - identifying the TaskExecutor which shall be released from the SlotPool

cause - for the releasing of the TaskManager

Returns:

true iff a given registered resource id was removed

offerSlots

Collection<SlotOffer> offerSlots(TaskManagerLocation taskManagerLocation,
                                 TaskManagerGateway taskManagerGateway,
                                 Collection<SlotOffer> offers)

Offers multiple slots to the SlotPool. The slot offerings can be individually accepted or rejected by returning the collection of accepted slot offers.

Parameters:

taskManagerLocation - from which the slot offers originate

taskManagerGateway - to talk to the slot offerer

offers - slot offers which are offered to the SlotPool

Returns:

A collection of accepted slot offers. The remaining slot offers are implicitly rejected.

failAllocation

Optional<ResourceID> failAllocation(AllocationID allocationID,
                                    Exception cause)

Fails the slot with the given allocation id.

Parameters:

allocationID - identifying the slot which is being failed

cause - of the failure

Returns:

An optional task executor id if this task executor has no more slots registered

getAvailableSlotsInformation

@Nonnull
Collection<SlotInfoWithUtilization> getAvailableSlotsInformation()

Returns a list of SlotInfoWithUtilization objects about all slots that are currently available in the slot pool.

Returns:

a list of SlotInfoWithUtilization objects about all slots that are currently available in the slot pool.

allocateAvailableSlot

Optional<PhysicalSlot> allocateAvailableSlot(@Nonnull
                                             SlotRequestId slotRequestId,
                                             @Nonnull
                                             AllocationID allocationID)

Allocates the available slot with the given allocation id under the given request id. This method returns null if no slot with the given allocation id is available.

Parameters:

slotRequestId - identifying the requested slot

allocationID - the allocation id of the requested available slot

Returns:

the previously available slot with the given allocation id or null if no such slot existed.

requestNewAllocatedSlot

@Nonnull
CompletableFuture<PhysicalSlot> requestNewAllocatedSlot(@Nonnull
                                                                 SlotRequestId slotRequestId,
                                                                 @Nonnull
                                                                 ResourceProfile resourceProfile,
                                                                 org.apache.flink.api.common.time.Time timeout)

Request the allocation of a new slot from the resource manager. This method will not return a slot from the already available slots from the pool, but instead will add a new slot to that pool that is immediately allocated and returned.

Parameters:

slotRequestId - identifying the requested slot

resourceProfile - resource profile that specifies the resource requirements for the requested slot

timeout - timeout for the allocation procedure

Returns:

a newly allocated slot that was previously not available.

requestNewAllocatedBatchSlot

@Nonnull
CompletableFuture<PhysicalSlot> requestNewAllocatedBatchSlot(@Nonnull
                                                                      SlotRequestId slotRequestId,
                                                                      @Nonnull
                                                                      ResourceProfile resourceProfile)

Requests the allocation of a new batch slot from the resource manager. Unlike the normal slot, a batch slot will only time out if the slot pool does not contain a suitable slot. Moreover, it won't react to failure signals from the resource manager.

Parameters:

slotRequestId - identifying the requested slot

resourceProfile - resource profile that specifies the resource requirements for the requested batch slot

Returns:

a future which is completed with newly allocated batch slot

createAllocatedSlotReport

AllocatedSlotReport createAllocatedSlotReport(ResourceID taskManagerId)

Create report about the allocated slots belonging to the specified task manager.

Parameters:

taskManagerId - identifies the task manager

Returns:

the allocated slots on the task manager