org.apache.flink.runtime.jobmaster.slotpool

Interface AllocatedSlotActions

All Known Subinterfaces:

SlotPoolGateway

All Known Implementing Classes:

SlotPool

public interface AllocatedSlotActions

Interface for components which have to perform actions on allocated slots.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	releaseSlot(SlotRequestId slotRequestId, SlotSharingGroupId slotSharingGroupId, Throwable cause) Releases the slot with the given SlotRequestId.

Method Detail

releaseSlot

CompletableFuture<Acknowledge> releaseSlot(SlotRequestId slotRequestId,
                                           @Nullable
                                           SlotSharingGroupId slotSharingGroupId,
                                           @Nullable
                                           Throwable cause)

Releases the slot with the given SlotRequestId. If the slot belonged to a slot sharing group, then the corresponding SlotSharingGroupId has to be provided. Additionally, one can provide a cause for the slot release.

Parameters:

slotRequestId - identifying the slot to release

slotSharingGroupId - identifying the slot sharing group to which the slot belongs, null if none

cause - of the slot release, null if none

Returns:

Acknowledge (future) after the slot has been released