org.apache.flink.runtime.resourcemanager

接口 ResourceManagerGateway

所有超级接口:

BlocklistListener, ClusterPartitionManager, org.apache.flink.runtime.rpc.FencedRpcGateway<ResourceManagerId>, org.apache.flink.runtime.rpc.RpcGateway

所有已知实现类:

ActiveResourceManager, ResourceManager, StandaloneResourceManager

public interface ResourceManagerGateway
extends org.apache.flink.runtime.rpc.FencedRpcGateway<ResourceManagerId>, ClusterPartitionManager, BlocklistListener

The ResourceManager's RPC gateway interface.

方法概要

限定符和类型	方法和说明
CompletableFuture<Acknowledge>	declareRequiredResources(JobMasterId jobMasterId, ResourceRequirements resourceRequirements, org.apache.flink.api.common.time.Time timeout) Declares the absolute resource requirements for a job.
CompletableFuture<Acknowledge>	deregisterApplication(ApplicationStatus finalStatus, String diagnostics) Deregister Flink from the underlying resource management system.
void	disconnectJobManager(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.JobStatus jobStatus, 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.
CompletableFuture<Void>	heartbeatFromJobManager(ResourceID heartbeatOrigin) Sends the heartbeat to resource manager from job manager.
CompletableFuture<Void>	heartbeatFromTaskManager(ResourceID heartbeatOrigin, TaskExecutorHeartbeatPayload heartbeatPayload) 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.
CompletableFuture<RegistrationResponse>	registerJobMaster(JobMasterId jobMasterId, ResourceID jobMasterResourceId, String jobMasterAddress, org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Register a JobMaster at the resource manager.
CompletableFuture<RegistrationResponse>	registerTaskExecutor(TaskExecutorRegistration taskExecutorRegistration, org.apache.flink.api.common.time.Time timeout) Register a TaskExecutor at the resource manager.
CompletableFuture<ResourceOverview>	requestResourceOverview(org.apache.flink.api.common.time.Time timeout) Requests the resource overview.
CompletableFuture<TaskExecutorThreadInfoGateway>	requestTaskExecutorThreadInfoGateway(ResourceID taskManagerId, org.apache.flink.api.common.time.Time timeout) Requests the TaskExecutorGateway.
CompletableFuture<TaskManagerInfoWithSlots>	requestTaskManagerDetailsInfo(ResourceID taskManagerId, org.apache.flink.api.common.time.Time timeout) Requests detail information about the given TaskExecutor.
CompletableFuture<TransientBlobKey>	requestTaskManagerFileUploadByName(ResourceID taskManagerId, String fileName, org.apache.flink.api.common.time.Time timeout) Request the file upload from the given TaskExecutor to the cluster's BlobServer.
CompletableFuture<TransientBlobKey>	requestTaskManagerFileUploadByType(ResourceID taskManagerId, FileType fileType, org.apache.flink.api.common.time.Time timeout) Request the file upload from the given TaskExecutor to the cluster's BlobServer.
CompletableFuture<Collection<TaskManagerInfo>>	requestTaskManagerInfo(org.apache.flink.api.common.time.Time timeout) Requests information about the registered TaskExecutor.
CompletableFuture<Collection<LogInfo>>	requestTaskManagerLogList(ResourceID taskManagerId, org.apache.flink.api.common.time.Time timeout) Request log list from the given TaskExecutor.
CompletableFuture<Collection<org.apache.flink.api.java.tuple.Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServiceAddresses(org.apache.flink.api.common.time.Time timeout) Requests the paths for the TaskManager's MetricQueryService to query.
CompletableFuture<ThreadDumpInfo>	requestThreadDump(ResourceID taskManagerId, org.apache.flink.api.common.time.Time timeout) Requests the thread dump from the given TaskExecutor.
CompletableFuture<Acknowledge>	sendSlotReport(ResourceID taskManagerResourceId, InstanceID taskManagerRegistrationId, SlotReport slotReport, org.apache.flink.api.common.time.Time timeout) Sends the given SlotReport to the ResourceManager.

从接口继承的方法 org.apache.flink.runtime.rpc.FencedRpcGateway

getFencingToken

从接口继承的方法 org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

从接口继承的方法 org.apache.flink.runtime.io.network.partition.ClusterPartitionManager

getClusterPartitionsShuffleDescriptors, listDataSets, releaseClusterPartitions, reportClusterPartitions

从接口继承的方法 org.apache.flink.runtime.blocklist.BlocklistListener

notifyNewBlockedNodes

方法详细资料

registerJobMaster

CompletableFuture<RegistrationResponse> registerJobMaster(JobMasterId jobMasterId,
                                                          ResourceID jobMasterResourceId,
                                                          String jobMasterAddress,
                                                          org.apache.flink.api.common.JobID jobId,
                                                          org.apache.flink.api.common.time.Time timeout)

Register a JobMaster at the resource manager.

参数:

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

返回:

Future registration response

declareRequiredResources

CompletableFuture<Acknowledge> declareRequiredResources(JobMasterId jobMasterId,
                                                        ResourceRequirements resourceRequirements,
                                                        org.apache.flink.api.common.time.Time timeout)

Declares the absolute resource requirements for a job.

参数:

jobMasterId - id of the JobMaster

resourceRequirements - resource requirements

返回:

The confirmation that the requirements have been processed

registerTaskExecutor

CompletableFuture<RegistrationResponse> registerTaskExecutor(TaskExecutorRegistration taskExecutorRegistration,
                                                             org.apache.flink.api.common.time.Time timeout)

Register a TaskExecutor at the resource manager.

参数:

taskExecutorRegistration - the task executor registration.

timeout - The timeout for the response.

返回:

The future to the response by the ResourceManager.

sendSlotReport

CompletableFuture<Acknowledge> sendSlotReport(ResourceID taskManagerResourceId,
                                              InstanceID taskManagerRegistrationId,
                                              SlotReport slotReport,
                                              org.apache.flink.api.common.time.Time timeout)

Sends the given SlotReport to the ResourceManager.

参数:

taskManagerRegistrationId - id identifying the sending TaskManager

slotReport - which is sent to the ResourceManager

timeout - for the operation

返回:

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.

参数:

instanceId - TaskExecutor's instance id

slotID - The SlotID of the freed slot

oldAllocationId - to which the slot has been allocated

deregisterApplication

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

Deregister Flink from the underlying resource management system.

参数:

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.

返回:

The future to the number of registered TaskManagers.

heartbeatFromTaskManager

CompletableFuture<Void> heartbeatFromTaskManager(ResourceID heartbeatOrigin,
                                                 TaskExecutorHeartbeatPayload heartbeatPayload)

Sends the heartbeat to resource manager from task manager.

参数:

heartbeatOrigin - unique id of the task manager

heartbeatPayload - payload from the originating TaskManager

返回:

future which is completed exceptionally if the operation fails

heartbeatFromJobManager

CompletableFuture<Void> heartbeatFromJobManager(ResourceID heartbeatOrigin)

Sends the heartbeat to resource manager from job manager.

参数:

heartbeatOrigin - unique id of the job manager

返回:

future which is completed exceptionally if the operation fails

disconnectTaskManager

void disconnectTaskManager(ResourceID resourceID,
                           Exception cause)

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

参数:

resourceID - identifying the TaskManager to disconnect

cause - for the disconnection of the TaskManager

disconnectJobManager

void disconnectJobManager(org.apache.flink.api.common.JobID jobId,
                          org.apache.flink.api.common.JobStatus jobStatus,
                          Exception cause)

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

参数:

jobId - JobID for which the JobManager was the leader

jobStatus - status of the job at the time of disconnection

cause - for the disconnection of the JobManager

requestTaskManagerInfo

CompletableFuture<Collection<TaskManagerInfo>> requestTaskManagerInfo(org.apache.flink.api.common.time.Time timeout)

Requests information about the registered TaskExecutor.

参数:

timeout - of the request

返回:

Future collection of TaskManager information

requestTaskManagerDetailsInfo

CompletableFuture<TaskManagerInfoWithSlots> requestTaskManagerDetailsInfo(ResourceID taskManagerId,
                                                                          org.apache.flink.api.common.time.Time timeout)

Requests detail information about the given TaskExecutor.

参数:

taskManagerId - identifying the TaskExecutor for which to return information

timeout - of the request

返回:

Future TaskManager information and its allocated slots

requestResourceOverview

CompletableFuture<ResourceOverview> requestResourceOverview(org.apache.flink.api.common.time.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.

参数:

timeout - of the request

返回:

Future containing the resource overview

requestTaskManagerMetricQueryServiceAddresses

CompletableFuture<Collection<org.apache.flink.api.java.tuple.Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServiceAddresses(org.apache.flink.api.common.time.Time timeout)

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

参数:

timeout - for the asynchronous operation

返回:

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

requestTaskManagerFileUploadByType

CompletableFuture<TransientBlobKey> requestTaskManagerFileUploadByType(ResourceID taskManagerId,
                                                                       FileType fileType,
                                                                       org.apache.flink.api.common.time.Time timeout)

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

参数:

taskManagerId - identifying the TaskExecutor to upload the specified file

fileType - type of the file to upload

timeout - for the asynchronous operation

返回:

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

requestTaskManagerFileUploadByName

CompletableFuture<TransientBlobKey> requestTaskManagerFileUploadByName(ResourceID taskManagerId,
                                                                       String fileName,
                                                                       org.apache.flink.api.common.time.Time timeout)

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

参数:

taskManagerId - identifying the TaskExecutor to upload the specified file

fileName - name of the file to upload

timeout - for the asynchronous operation

返回:

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

requestTaskManagerLogList

CompletableFuture<Collection<LogInfo>> requestTaskManagerLogList(ResourceID taskManagerId,
                                                                 org.apache.flink.api.common.time.Time timeout)

Request log list from the given TaskExecutor.

参数:

taskManagerId - identifying the TaskExecutor to get log list from

timeout - for the asynchronous operation

返回:

Future which is completed with the historical log list

requestThreadDump

CompletableFuture<ThreadDumpInfo> requestThreadDump(ResourceID taskManagerId,
                                                    org.apache.flink.api.common.time.Time timeout)

Requests the thread dump from the given TaskExecutor.

参数:

taskManagerId - taskManagerId identifying the TaskExecutor to get the thread dump from

timeout - timeout of the asynchronous operation

返回:

Future containing the thread dump information

requestTaskExecutorThreadInfoGateway

CompletableFuture<TaskExecutorThreadInfoGateway> requestTaskExecutorThreadInfoGateway(ResourceID taskManagerId,
                                                                                      org.apache.flink.api.common.time.Time timeout)

Requests the TaskExecutorGateway.

参数:

taskManagerId - identifying the TaskExecutor.

返回:

Future containing the task executor gateway.