org.apache.flink.runtime.protocols

Interface ExtendedManagementProtocol

All Superinterfaces:

JobManagementProtocol, ServiceDiscoveryProtocol, VersionedProtocol

All Known Implementing Classes:

JobManager

public interface ExtendedManagementProtocol
extends JobManagementProtocol

This protocol provides extended management capabilities beyond the simple JobManagementProtocol. It can be used to retrieve internal scheduling information, the network topology, or profiling information about thread or instance utilization.

Method Summary

Methods

Modifier and Type	Method and Description
List<AbstractEvent>	getEvents(JobID jobID) Retrieves the collected events for the job with the given job ID.
int	getNumberOfSlotsAvailableToScheduler()
List<RecentJobEvent>	getRecentJobs() Retrieves a list of jobs which have either running or have been started recently.
int	getTotalNumberOfRegisteredSlots() Returns the number of available slots among the registered task managers

Methods inherited from interface org.apache.flink.runtime.protocols.JobManagementProtocol

cancelJob, getJobProgress, getRecommendedPollingInterval, submitJob

Methods inherited from interface org.apache.flink.runtime.protocols.ServiceDiscoveryProtocol

getBlobServerPort

Method Detail

getRecentJobs

List<RecentJobEvent> getRecentJobs()
                                   throws IOException

Retrieves a list of jobs which have either running or have been started recently.

Returns:

a (possibly) empty list of recent jobs

Throws:

IOException - thrown if an error occurs while retrieving the job list

getEvents

List<AbstractEvent> getEvents(JobID jobID)
                              throws IOException

Retrieves the collected events for the job with the given job ID.

Parameters:

jobID - the ID of the job to retrieve the events for

Returns:

a (possibly empty) list of events which occurred for that event and which are not older than the query interval

Throws:

IOException - thrown if an error occurs while retrieving the list of events

getTotalNumberOfRegisteredSlots

int getTotalNumberOfRegisteredSlots()
                                    throws IOException

Returns the number of available slots among the registered task managers

Returns:

number of available slots

Throws:

IOException

getNumberOfSlotsAvailableToScheduler

int getNumberOfSlotsAvailableToScheduler()
                                         throws IOException

Throws:

IOException