DefaultDeclarativeSlotPool (Flink : Runtime 1.15.0 API)

java.lang.Object
- org.apache.flink.runtime.jobmaster.slotpool.DefaultDeclarativeSlotPool

所有已实现的接口:

DeclarativeSlotPool
```
public class DefaultDeclarativeSlotPool
extends Object
implements DeclarativeSlotPool
```
Default DeclarativeSlotPool implementation.
The implementation collects the current resource requirements and declares them at the ResourceManager. Whenever new slots are offered, the slot pool compares the offered slots to the set of available and required resources and only accepts those slots which are required.
Slots which are released won't be returned directly to their owners. Instead, the slot pool implementation will only return them after the idleSlotTimeout has been exceeded by a free slot.
The slot pool will call newSlotsListener whenever newly offered slots are accepted or if an allocated slot should become free after it is being freed.
This class expects 1 of 2 access patterns for changing requirements, which should not be mixed:
1) the legacy approach (used by the DefaultScheduler) tightly couples requirements to reserved slots. When a slot is requested it increases the requirements, when the slot is freed they are decreased again. In the general case what happens is that requirements are increased, a free slot is reserved, (the slot is used for a bit,) the slot is freed, the requirements are reduced. To this end freeReservedSlot(org.apache.flink.runtime.clusterframework.types.AllocationID, java.lang.Throwable, long), releaseSlot(org.apache.flink.runtime.clusterframework.types.AllocationID, java.lang.Exception) and releaseSlots(org.apache.flink.runtime.clusterframework.types.ResourceID, java.lang.Exception) return a ResourceCounter describing which requirement the slot(s) were fulfilling, with the expectation that the scheduler will subsequently decrease the requirements by that amount.
2) The declarative approach (used by the AdaptiveScheduler) in contrast derives requirements exclusively based on what a given job currently requires. It may repeatedly reserve/free slots without any modifications to the requirements.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.flink.runtime.jobmaster.slotpool.DeclarativeSlotPool
  DeclarativeSlotPool.NewSlotsListener, DeclarativeSlotPool.NoOpNewSlotsListener

构造器概要

构造器
构造器和说明
`DefaultDeclarativeSlotPool(org.apache.flink.api.common.JobID jobId, AllocatedSlotPool slotPool, java.util.function.Consumer<? super Collection<ResourceRequirement>> notifyNewResourceRequirements, org.apache.flink.api.common.time.Time idleSlotTimeout, org.apache.flink.api.common.time.Time rpcTimeout)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`containsFreeSlot(AllocationID allocationId)` Checks whether the slot pool contains a slot with the given `AllocationID` and if it is free.
`boolean`	`containsSlots(ResourceID owner)` Returns whether the slot pool has a slot registered which is owned by the given TaskExecutor.
`void`	`decreaseResourceRequirementsBy(ResourceCounter decrement)` Decreases the resource requirements by decrement.
`ResourceCounter`	`freeReservedSlot(AllocationID allocationId, Throwable cause, long currentTime)` Frees the reserved slot identified by the given allocationId.
`Collection<? extends SlotInfo>`	`getAllSlotsInformation()` Returns the slot information for all slots (free and allocated slots).
`Collection<SlotInfoWithUtilization>`	`getFreeSlotsInformation()` Returns the slot information for all free slots (slots which can be allocated from the slot pool).
`Collection<ResourceRequirement>`	`getResourceRequirements()` Returns the current resource requirements.
`void`	`increaseResourceRequirementsBy(ResourceCounter increment)` Increases the resource requirements by increment.
`Collection<SlotOffer>`	`offerSlots(Collection<? extends SlotOffer> offers, TaskManagerLocation taskManagerLocation, TaskManagerGateway taskManagerGateway, long currentTime)` Offers slots to this slot pool.
`void`	`registerNewSlotsListener(DeclarativeSlotPool.NewSlotsListener newSlotsListener)` Registers a listener which is called whenever new slots become available.
`void`	`registerSlots(Collection<? extends SlotOffer> slots, TaskManagerLocation taskManagerLocation, TaskManagerGateway taskManagerGateway, long currentTime)` Registers the given set of slots at the slot pool.
`void`	`releaseIdleSlots(long currentTimeMillis)` Releases slots which have exceeded the idle slot timeout and are no longer needed to fulfill the resource requirements.
`ResourceCounter`	`releaseSlot(AllocationID allocationId, Exception cause)` Releases the slot specified by allocationId if one exists.
`ResourceCounter`	`releaseSlots(ResourceID owner, Exception cause)` Releases all slots belonging to the owning TaskExecutor if it has been registered.
`PhysicalSlot`	`reserveFreeSlot(AllocationID allocationId, ResourceProfile requiredSlotProfile)` Reserves the free slot identified by the given allocationId and maps it to the given requiredSlotProfile.
`void`	`setResourceRequirements(ResourceCounter resourceRequirements)` Sets the resource requirements to the given resourceRequirements.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DefaultDeclarativeSlotPool
```
public DefaultDeclarativeSlotPool(org.apache.flink.api.common.JobID jobId,
                                  AllocatedSlotPool slotPool,
                                  java.util.function.Consumer<? super Collection<ResourceRequirement>> notifyNewResourceRequirements,
                                  org.apache.flink.api.common.time.Time idleSlotTimeout,
                                  org.apache.flink.api.common.time.Time rpcTimeout)
```
- 方法详细资料
  - increaseResourceRequirementsBy
```
public void increaseResourceRequirementsBy(ResourceCounter increment)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Increases the resource requirements by increment.
    
    指定者:
    
    increaseResourceRequirementsBy 在接口中 DeclarativeSlotPool
    
    参数:
    
    increment - increment by which to increase the resource requirements
  - decreaseResourceRequirementsBy
```
public void decreaseResourceRequirementsBy(ResourceCounter decrement)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Decreases the resource requirements by decrement.
    
    指定者:
    
    decreaseResourceRequirementsBy 在接口中 DeclarativeSlotPool
    
    参数:
    
    decrement - decrement by which to decrease the resource requirements
  - setResourceRequirements
```
public void setResourceRequirements(ResourceCounter resourceRequirements)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Sets the resource requirements to the given resourceRequirements.
    
    指定者:
    
    setResourceRequirements 在接口中 DeclarativeSlotPool
    
    参数:
    
    resourceRequirements - new resource requirements
  - getResourceRequirements
```
public Collection<ResourceRequirement> getResourceRequirements()
```
    从接口复制的说明: DeclarativeSlotPool
    
    Returns the current resource requirements.
    
    指定者:
    
    getResourceRequirements 在接口中 DeclarativeSlotPool
    
    返回:
    
    current resource requirements
  - offerSlots
```
public Collection<SlotOffer> offerSlots(Collection<? extends SlotOffer> offers,
                                        TaskManagerLocation taskManagerLocation,
                                        TaskManagerGateway taskManagerGateway,
                                        long currentTime)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Offers slots to this slot pool. The slot pool is free to accept as many slots as it needs.
    
    指定者:
    
    offerSlots 在接口中 DeclarativeSlotPool
    
    参数:
    
    offers - offers containing the list of slots offered to this slot pool
    
    taskManagerLocation - taskManagerLocation is the location of the offering TaskExecutor
    
    taskManagerGateway - taskManagerGateway is the gateway to talk to the offering TaskExecutor
    
    currentTime - currentTime is the time the slots are being offered
    
    返回:
    
    collection of accepted slots; the other slot offers are implicitly rejected
  - registerSlots
```
public void registerSlots(Collection<? extends SlotOffer> slots,
                          TaskManagerLocation taskManagerLocation,
                          TaskManagerGateway taskManagerGateway,
                          long currentTime)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Registers the given set of slots at the slot pool.
    
    指定者:
    
    registerSlots 在接口中 DeclarativeSlotPool
    
    参数:
    
    slots - slots to register
    
    taskManagerLocation - taskManagerLocation is the location of the offering TaskExecutor
    
    taskManagerGateway - taskManagerGateway is the gateway to talk to the offering TaskExecutor
    
    currentTime - currentTime is the time the slots are being offered
  - reserveFreeSlot
```
public PhysicalSlot reserveFreeSlot(AllocationID allocationId,
                                    ResourceProfile requiredSlotProfile)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Reserves the free slot identified by the given allocationId and maps it to the given requiredSlotProfile.
    
    指定者:
    
    reserveFreeSlot 在接口中 DeclarativeSlotPool
    
    参数:
    
    allocationId - allocationId identifies the free slot to allocate
    
    requiredSlotProfile - requiredSlotProfile specifying the resource requirement
    
    返回:
    
    a PhysicalSlot representing the allocated slot
  - freeReservedSlot
```
public ResourceCounter freeReservedSlot(AllocationID allocationId,
                                        @Nullable
                                        Throwable cause,
                                        long currentTime)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Frees the reserved slot identified by the given allocationId. If no slot with allocationId exists, then the call is ignored.
    Whether the freed slot is returned to the owning TaskExecutor is implementation dependent.
    
    指定者:
    
    freeReservedSlot 在接口中 DeclarativeSlotPool
    
    参数:
    
    allocationId - allocationId identifying the slot to release
    
    cause - cause for releasing the slot; can be null
    
    currentTime - currentTime when the slot was released
    
    返回:
    
    the resource requirements that the slot was fulfilling
  - registerNewSlotsListener
```
public void registerNewSlotsListener(DeclarativeSlotPool.NewSlotsListener newSlotsListener)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Registers a listener which is called whenever new slots become available.
    
    指定者:
    
    registerNewSlotsListener 在接口中 DeclarativeSlotPool
    
    参数:
    
    newSlotsListener - which is called whenever new slots become available
  - releaseSlots
```
public ResourceCounter releaseSlots(ResourceID owner,
                                    Exception cause)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Releases all slots belonging to the owning TaskExecutor if it has been registered.
    
    指定者:
    
    releaseSlots 在接口中 DeclarativeSlotPool
    
    参数:
    
    owner - owner identifying the owning TaskExecutor
    
    cause - cause for failing the slots
    
    返回:
    
    the resource requirements that all slots were fulfilling; empty if all slots were currently free
  - releaseSlot
```
public ResourceCounter releaseSlot(AllocationID allocationId,
                                   Exception cause)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Releases the slot specified by allocationId if one exists.
    
    指定者:
    
    releaseSlot 在接口中 DeclarativeSlotPool
    
    参数:
    
    allocationId - allocationId identifying the slot to fail
    
    cause - cause for failing the slot
    
    返回:
    
    the resource requirements that the slot was fulfilling; empty if the slot was currently free
  - releaseIdleSlots
```
public void releaseIdleSlots(long currentTimeMillis)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Releases slots which have exceeded the idle slot timeout and are no longer needed to fulfill the resource requirements.
    
    指定者:
    
    releaseIdleSlots 在接口中 DeclarativeSlotPool
    
    参数:
    
    currentTimeMillis - current time
  - getFreeSlotsInformation
```
public Collection<SlotInfoWithUtilization> getFreeSlotsInformation()
```
    从接口复制的说明: DeclarativeSlotPool
    
    Returns the slot information for all free slots (slots which can be allocated from the slot pool).
    
    指定者:
    
    getFreeSlotsInformation 在接口中 DeclarativeSlotPool
    
    返回:
    
    collection of free slot information
  - getAllSlotsInformation
```
public Collection<? extends SlotInfo> getAllSlotsInformation()
```
    从接口复制的说明: DeclarativeSlotPool
    
    Returns the slot information for all slots (free and allocated slots).
    
    指定者:
    
    getAllSlotsInformation 在接口中 DeclarativeSlotPool
    
    返回:
    
    collection of slot information
  - containsFreeSlot
```
public boolean containsFreeSlot(AllocationID allocationId)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Checks whether the slot pool contains a slot with the given AllocationID and if it is free.
    
    指定者:
    
    containsFreeSlot 在接口中 DeclarativeSlotPool
    
    参数:
    
    allocationId - allocationId specifies the slot to check for
    
    返回:
    
    true if the slot pool contains a free slot registered under the given allocation id; otherwise false
  - containsSlots
```
public boolean containsSlots(ResourceID owner)
```
    从接口复制的说明: DeclarativeSlotPool
    
    Returns whether the slot pool has a slot registered which is owned by the given TaskExecutor.
    
    指定者:
    
    containsSlots 在接口中 DeclarativeSlotPool
    
    参数:
    
    owner - owner identifying the TaskExecutor for which to check whether the slot pool has some slots registered
    
    返回:
    
    true if the given TaskExecutor has a slot registered at the slot pool

类 DefaultDeclarativeSlotPool

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.runtime.jobmaster.slotpool.DeclarativeSlotPool

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DefaultDeclarativeSlotPool

方法详细资料

increaseResourceRequirementsBy

decreaseResourceRequirementsBy

setResourceRequirements

getResourceRequirements

offerSlots

registerSlots

reserveFreeSlot

freeReservedSlot

registerNewSlotsListener

releaseSlots

releaseSlot

releaseIdleSlots

getFreeSlotsInformation

getAllSlotsInformation

containsFreeSlot

containsSlots