org.apache.flink.runtime.resourcemanager

Interface ResourceManagerGateway

All Superinterfaces:

FencedRpcGateway<ResourceManagerId>, RpcGateway

All Known Implementing Classes:

MesosResourceManager, ResourceManager, StandaloneResourceManager, YarnResourceManager

public interface ResourceManagerGateway
extends FencedRpcGateway<ResourceManagerId>

The ResourceManager's RPC gateway interface.

Method Summary

Modifier and Type	Method and Description
void	cancelSlotRequest(AllocationID allocationID) Cancel the slot allocation requests from the resource manager.
CompletableFuture<Acknowledge>	deregisterApplication(ApplicationStatus finalStatus, String diagnostics) Deregister Flink from the underlying resource management system.
void	disconnectJobManager(JobID jobId, Exception cause) Disconnects a JobManager specified by the given resourceID from the ResourceManager.
void	disconnectTaskManager(ResourceID resourceID, Exception cause) Disconnects a TaskManager specified by the given resourceID from the ResourceManager.
CompletableFuture<Integer>	getNumberOfRegisteredTaskManagers() Gets the currently registered number of TaskManagers.
void	heartbeatFromJobManager(ResourceID heartbeatOrigin) Sends the heartbeat to resource manager from job manager
void	heartbeatFromTaskManager(ResourceID heartbeatOrigin, SlotReport slotReport) Sends the heartbeat to resource manager from task manager
void	notifySlotAvailable(InstanceID instanceId, SlotID slotID, AllocationID oldAllocationId) Sent by the TaskExecutor to notify the ResourceManager that a slot has become available.
void	registerInfoMessageListener(String infoMessageListenerAddress) Registers an infoMessage listener
CompletableFuture<RegistrationResponse>	registerJobManager(JobMasterId jobMasterId, ResourceID jobMasterResourceId, String jobMasterAddress, JobID jobId, Time timeout) Register a JobMaster at the resource manager.
CompletableFuture<RegistrationResponse>	registerTaskExecutor(String taskExecutorAddress, ResourceID resourceId, int dataPort, HardwareDescription hardwareDescription, Time timeout) Register a TaskExecutor at the resource manager.
CompletableFuture<ResourceOverview>	requestResourceOverview(Time timeout) Requests the resource overview.
CompletableFuture<Acknowledge>	requestSlot(JobMasterId jobMasterId, SlotRequest slotRequest, Time timeout) Requests a slot from the resource manager.
CompletableFuture<TransientBlobKey>	requestTaskManagerFileUpload(ResourceID taskManagerId, FileType fileType, Time timeout) Request the file upload from the given TaskExecutor to the cluster's BlobServer.
CompletableFuture<TaskManagerInfo>	requestTaskManagerInfo(ResourceID taskManagerId, Time timeout) Requests information about the given TaskExecutor.
CompletableFuture<Collection<TaskManagerInfo>>	requestTaskManagerInfo(Time timeout) Requests information about the registered TaskExecutor.
CompletableFuture<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServicePaths(Time timeout) Requests the paths for the TaskManager's MetricQueryService to query.
CompletableFuture<Acknowledge>	sendSlotReport(ResourceID taskManagerResourceId, InstanceID taskManagerRegistrationId, SlotReport slotReport, Time timeout) Sends the given SlotReport to the ResourceManager.
void	unRegisterInfoMessageListener(String infoMessageListenerAddress) Unregisters an infoMessage listener

Methods inherited from interface org.apache.flink.runtime.rpc.FencedRpcGateway

getFencingToken

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

Method Detail

registerJobManager

CompletableFuture<RegistrationResponse> registerJobManager(JobMasterId jobMasterId,
                                                           ResourceID jobMasterResourceId,
                                                           String jobMasterAddress,
                                                           JobID jobId,
                                                           Time timeout)

Register a JobMaster at the resource manager.

Parameters:

jobMasterId - The fencing token for the JobMaster leader

jobMasterResourceId - The resource ID of the JobMaster that registers

jobMasterAddress - The address of the JobMaster that registers

jobId - The Job ID of the JobMaster that registers

timeout - Timeout for the future to complete

Returns:

Future registration response

requestSlot

CompletableFuture<Acknowledge> requestSlot(JobMasterId jobMasterId,
                                           SlotRequest slotRequest,
                                           Time timeout)

Requests a slot from the resource manager.

Parameters:

jobMasterId - id of the JobMaster

slotRequest - The slot to request

Returns:

The confirmation that the slot gets allocated

cancelSlotRequest

void cancelSlotRequest(AllocationID allocationID)

Cancel the slot allocation requests from the resource manager.

Parameters:

allocationID - The slot to request

registerTaskExecutor

CompletableFuture<RegistrationResponse> registerTaskExecutor(String taskExecutorAddress,
                                                             ResourceID resourceId,
                                                             int dataPort,
                                                             HardwareDescription hardwareDescription,
                                                             Time timeout)

Register a TaskExecutor at the resource manager.

Parameters:

taskExecutorAddress - The address of the TaskExecutor that registers

resourceId - The resource ID of the TaskExecutor that registers

dataPort - port used for data communication between TaskExecutors

hardwareDescription - of the registering TaskExecutor

timeout - The timeout for the response.

Returns:

The future to the response by the ResourceManager.

sendSlotReport

CompletableFuture<Acknowledge> sendSlotReport(ResourceID taskManagerResourceId,
                                              InstanceID taskManagerRegistrationId,
                                              SlotReport slotReport,
                                              Time timeout)

Sends the given SlotReport to the ResourceManager.

Parameters:

taskManagerRegistrationId - id identifying the sending TaskManager

slotReport - which is sent to the ResourceManager

timeout - for the operation

Returns:

Future which is completed with Acknowledge once the slot report has been received.

notifySlotAvailable

void notifySlotAvailable(InstanceID instanceId,
                         SlotID slotID,
                         AllocationID oldAllocationId)

Sent by the TaskExecutor to notify the ResourceManager that a slot has become available.

Parameters:

instanceId - TaskExecutor's instance id

slotID - The SlotID of the freed slot

oldAllocationId - to which the slot has been allocated

registerInfoMessageListener

void registerInfoMessageListener(String infoMessageListenerAddress)

Registers an infoMessage listener

Parameters:

infoMessageListenerAddress - address of infoMessage listener to register to this resource manager

unRegisterInfoMessageListener

void unRegisterInfoMessageListener(String infoMessageListenerAddress)

Unregisters an infoMessage listener

Parameters:

infoMessageListenerAddress - address of infoMessage listener to unregister from this resource manager

deregisterApplication

CompletableFuture<Acknowledge> deregisterApplication(ApplicationStatus finalStatus,
                                                     @Nullable
                                                     String diagnostics)

Deregister Flink from the underlying resource management system.

Parameters:

finalStatus - final status with which to deregister the Flink application

diagnostics - additional information for the resource management system, can be null

getNumberOfRegisteredTaskManagers

CompletableFuture<Integer> getNumberOfRegisteredTaskManagers()

Gets the currently registered number of TaskManagers.

Returns:

The future to the number of registered TaskManagers.

heartbeatFromTaskManager

void heartbeatFromTaskManager(ResourceID heartbeatOrigin,
                              SlotReport slotReport)

Sends the heartbeat to resource manager from task manager

Parameters:

heartbeatOrigin - unique id of the task manager

slotReport - Current slot allocation on the originating TaskManager

heartbeatFromJobManager

void heartbeatFromJobManager(ResourceID heartbeatOrigin)

Sends the heartbeat to resource manager from job manager

Parameters:

heartbeatOrigin - unique id of the job manager

disconnectTaskManager

void disconnectTaskManager(ResourceID resourceID,
                           Exception cause)

Disconnects a TaskManager specified by the given resourceID from the ResourceManager.

Parameters:

resourceID - identifying the TaskManager to disconnect

cause - for the disconnection of the TaskManager

disconnectJobManager

void disconnectJobManager(JobID jobId,
                          Exception cause)

Disconnects a JobManager specified by the given resourceID from the ResourceManager.

Parameters:

jobId - JobID for which the JobManager was the leader

cause - for the disconnection of the JobManager

requestTaskManagerInfo

CompletableFuture<Collection<TaskManagerInfo>> requestTaskManagerInfo(Time timeout)

Requests information about the registered TaskExecutor.

Parameters:

timeout - of the request

Returns:

Future collection of TaskManager information

requestTaskManagerInfo

CompletableFuture<TaskManagerInfo> requestTaskManagerInfo(ResourceID taskManagerId,
                                                          Time timeout)

Requests information about the given TaskExecutor.

Parameters:

taskManagerId - identifying the TaskExecutor for which to return information

timeout - of the request

Returns:

Future TaskManager information

requestResourceOverview

CompletableFuture<ResourceOverview> requestResourceOverview(Time timeout)

Requests the resource overview. The resource overview provides information about the connected TaskManagers, the total number of slots and the number of available slots.

Parameters:

timeout - of the request

Returns:

Future containing the resource overview

requestTaskManagerMetricQueryServicePaths

CompletableFuture<Collection<Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServicePaths(Time timeout)

Requests the paths for the TaskManager's MetricQueryService to query.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of resource ids and the corresponding metric query service path

requestTaskManagerFileUpload

CompletableFuture<TransientBlobKey> requestTaskManagerFileUpload(ResourceID taskManagerId,
                                                                 FileType fileType,
                                                                 Time timeout)

Request the file upload from the given TaskExecutor to the cluster's BlobServer. The corresponding TransientBlobKey is returned.

Parameters:

taskManagerId - identifying the TaskExecutor to upload the specified file

fileType - type of the file to upload

timeout - for the asynchronous operation

Returns:

Future which is completed with the TransientBlobKey after uploading the file to the BlobServer.