org.apache.flink.runtime.jobmaster.slotpool

Interface SlotProvider

All Known Subinterfaces:

Scheduler

All Known Implementing Classes:

Scheduler, SchedulerImpl

public interface SlotProvider

The slot provider is responsible for preparing slots for ready-to-run tasks.

It supports two allocating modes:

• Immediate allocating: A request for a task slot immediately gets satisfied, we can call CompletableFuture.getNow(Object) to get the allocated slot.
• Queued allocating: A request for a task slot is queued and returns a future that will be fulfilled as soon as a slot becomes available.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<LogicalSlot>	allocateSlot(ScheduledUnit scheduledUnit, boolean allowQueued, SlotProfile slotProfile, org.apache.flink.api.common.time.Time allocationTimeout) Allocating slot with specific requirement.
CompletableFuture<LogicalSlot>	allocateSlot(SlotRequestId slotRequestId, ScheduledUnit scheduledUnit, SlotProfile slotProfile, boolean allowQueuedScheduling, org.apache.flink.api.common.time.Time allocationTimeout) Allocating slot with specific requirement.
void	cancelSlotRequest(SlotRequestId slotRequestId, SlotSharingGroupId slotSharingGroupId, Throwable cause) Cancels the slot request with the given SlotRequestId and SlotSharingGroupId.

Method Detail

allocateSlot

CompletableFuture<LogicalSlot> allocateSlot(SlotRequestId slotRequestId,
                                            ScheduledUnit scheduledUnit,
                                            SlotProfile slotProfile,
                                            boolean allowQueuedScheduling,
                                            org.apache.flink.api.common.time.Time allocationTimeout)

Allocating slot with specific requirement.

Parameters:

slotRequestId - identifying the slot request

scheduledUnit - The task to allocate the slot for

slotProfile - profile of the requested slot

allowQueuedScheduling - Whether allow the task be queued if we do not have enough resource

allocationTimeout - after which the allocation fails with a timeout exception

Returns:

The future of the allocation

allocateSlot

default CompletableFuture<LogicalSlot> allocateSlot(ScheduledUnit scheduledUnit,
                                                    boolean allowQueued,
                                                    SlotProfile slotProfile,
                                                    org.apache.flink.api.common.time.Time allocationTimeout)

Allocating slot with specific requirement.

Parameters:

scheduledUnit - The task to allocate the slot for

allowQueued - Whether allow the task be queued if we do not have enough resource

slotProfile - profile of the requested slot

allocationTimeout - after which the allocation fails with a timeout exception

Returns:

The future of the allocation

cancelSlotRequest

void cancelSlotRequest(SlotRequestId slotRequestId,
                       @Nullable
                       SlotSharingGroupId slotSharingGroupId,
                       Throwable cause)

Cancels the slot request with the given SlotRequestId and SlotSharingGroupId.

Parameters:

slotRequestId - identifying the slot request to cancel

slotSharingGroupId - identifying the slot request to cancel

cause - of the cancellation