org.apache.flink.runtime.jobmaster

Interface JobMasterGateway

All Superinterfaces:

CheckpointCoordinatorGateway, FencedRpcGateway<JobMasterId>, RpcGateway

All Known Implementing Classes:

JobMaster

public interface JobMasterGateway
extends CheckpointCoordinatorGateway, FencedRpcGateway<JobMasterId>

JobMaster rpc gateway interface

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancel(Time timeout) Cancels the currently executed job.
void	disconnectResourceManager(ResourceManagerId resourceManagerId, Exception cause) Disconnects the resource manager from the job manager because of the given cause.
void	disconnectTaskManager(ResourceID resourceID, Exception cause) Disconnects the given TaskExecutor from the JobMaster.
void	failSlot(ResourceID taskManagerId, AllocationID allocationId, Exception cause) Fails the slot with the given allocation id and cause.
void	heartbeatFromResourceManager(ResourceID resourceID) Sends heartbeat request from the resource manager
void	heartbeatFromTaskManager(ResourceID resourceID) Sends the heartbeat to job manager from task manager
CompletableFuture<KvStateLocation>	lookupKvStateLocation(String registrationName) Requests a KvStateLocation for the specified InternalKvState registration name.
void	notifyKvStateRegistered(JobVertexID jobVertexId, KeyGroupRange keyGroupRange, String registrationName, KvStateID kvStateId, InetSocketAddress kvStateServerAddress) Notifies that queryable state has been registered.
void	notifyKvStateUnregistered(JobVertexID jobVertexId, KeyGroupRange keyGroupRange, String registrationName) Notifies that queryable state has been unregistered.
CompletableFuture<Collection<SlotOffer>>	offerSlots(ResourceID taskManagerId, Iterable<SlotOffer> slots, Time timeout) Offers the given slots to the job manager.
CompletableFuture<RegistrationResponse>	registerTaskManager(String taskManagerRpcAddress, TaskManagerLocation taskManagerLocation, Time timeout) Registers the task manager at the job manager.
CompletableFuture<AccessExecutionGraph>	requestArchivedExecutionGraph(Time timeout) Request the ArchivedExecutionGraph of the currently executed job.
CompletableFuture<ClassloadingProps>	requestClassloadingProps() Request the classloading props of this job.
CompletableFuture<JobDetails>	requestJobDetails(Time timeout) Request the details of the executed job.
CompletableFuture<JobStatus>	requestJobStatus(Time timeout) Requests the current job status.
CompletableFuture<SerializedInputSplit>	requestNextInputSplit(JobVertexID vertexID, ExecutionAttemptID executionAttempt) Requests the next input split for the ExecutionJobVertex.
CompletableFuture<ExecutionState>	requestPartitionState(IntermediateDataSetID intermediateResultId, ResultPartitionID partitionId) Requests the current state of the partition.
CompletableFuture<Acknowledge>	scheduleOrUpdateConsumers(ResultPartitionID partitionID, Time timeout) Notifies the JobManager about available data for a produced partition.
CompletableFuture<Acknowledge>	stop(Time timeout) Cancel the currently executed job.
CompletableFuture<Acknowledge>	updateTaskExecutionState(TaskExecutionState taskExecutionState) Updates the task execution state for a given task.

Methods inherited from interface org.apache.flink.runtime.checkpoint.CheckpointCoordinatorGateway

acknowledgeCheckpoint, declineCheckpoint

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

cancel

CompletableFuture<Acknowledge> cancel(Time timeout)

Cancels the currently executed job.

Parameters:

timeout - of this operation

Returns:

Future acknowledge of the operation

stop

CompletableFuture<Acknowledge> stop(Time timeout)

Cancel the currently executed job.

Parameters:

timeout - of this operation

Returns:

Future acknowledge if the cancellation was successful

updateTaskExecutionState

CompletableFuture<Acknowledge> updateTaskExecutionState(TaskExecutionState taskExecutionState)

Updates the task execution state for a given task.

Parameters:

taskExecutionState - New task execution state for a given task

Returns:

Future flag of the task execution state update result

requestNextInputSplit

CompletableFuture<SerializedInputSplit> requestNextInputSplit(JobVertexID vertexID,
                                                              ExecutionAttemptID executionAttempt)

Requests the next input split for the ExecutionJobVertex. The next input split is sent back to the sender as a SerializedInputSplit message.

Parameters:

vertexID - The job vertex id

executionAttempt - The execution attempt id

Returns:

The future of the input split. If there is no further input split, will return an empty object.

requestPartitionState

CompletableFuture<ExecutionState> requestPartitionState(IntermediateDataSetID intermediateResultId,
                                                        ResultPartitionID partitionId)

Requests the current state of the partition. The state of a partition is currently bound to the state of the producing execution.

Parameters:

intermediateResultId - The execution attempt ID of the task requesting the partition state.

partitionId - The partition ID of the partition to request the state of.

Returns:

The future of the partition state

scheduleOrUpdateConsumers

CompletableFuture<Acknowledge> scheduleOrUpdateConsumers(ResultPartitionID partitionID,
                                                         Time timeout)

Notifies the JobManager about available data for a produced partition.

There is a call to this method for each ExecutionVertex instance once per produced ResultPartition instance, either when first producing data (for pipelined executions) or when all data has been produced (for staged executions).

The JobManager then can decide when to schedule the partition consumers of the given session.

Parameters:

partitionID - The partition which has already produced data

timeout - before the rpc call fails

Returns:

Future acknowledge of the schedule or update operation

disconnectTaskManager

void disconnectTaskManager(ResourceID resourceID,
                           Exception cause)

Disconnects the given TaskExecutor from the JobMaster.

Parameters:

resourceID - identifying the TaskManager to disconnect

cause - for the disconnection of the TaskManager

disconnectResourceManager

void disconnectResourceManager(ResourceManagerId resourceManagerId,
                               Exception cause)

Disconnects the resource manager from the job manager because of the given cause.

Parameters:

resourceManagerId - identifying the resource manager leader id

cause - of the disconnect

lookupKvStateLocation

CompletableFuture<KvStateLocation> lookupKvStateLocation(String registrationName)

Requests a KvStateLocation for the specified InternalKvState registration name.

Parameters:

registrationName - Name under which the KvState has been registered.

Returns:

Future of the requested InternalKvState location

notifyKvStateRegistered

void notifyKvStateRegistered(JobVertexID jobVertexId,
                             KeyGroupRange keyGroupRange,
                             String registrationName,
                             KvStateID kvStateId,
                             InetSocketAddress kvStateServerAddress)

Notifies that queryable state has been registered.

Parameters:

jobVertexId - JobVertexID the KvState instance belongs to.

keyGroupRange - Key group range the KvState instance belongs to.

registrationName - Name under which the KvState has been registered.

kvStateId - ID of the registered KvState instance.

kvStateServerAddress - Server address where to find the KvState instance.

notifyKvStateUnregistered

void notifyKvStateUnregistered(JobVertexID jobVertexId,
                               KeyGroupRange keyGroupRange,
                               String registrationName)

Notifies that queryable state has been unregistered.

Parameters:

jobVertexId - JobVertexID the KvState instance belongs to.

keyGroupRange - Key group index the KvState instance belongs to.

registrationName - Name under which the KvState has been registered.

requestClassloadingProps

CompletableFuture<ClassloadingProps> requestClassloadingProps()

Request the classloading props of this job.

offerSlots

CompletableFuture<Collection<SlotOffer>> offerSlots(ResourceID taskManagerId,
                                                    Iterable<SlotOffer> slots,
                                                    Time timeout)

Offers the given slots to the job manager. The response contains the set of accepted slots.

Parameters:

taskManagerId - identifying the task manager

slots - to offer to the job manager

timeout - for the rpc call

Returns:

Future set of accepted slots.

failSlot

void failSlot(ResourceID taskManagerId,
              AllocationID allocationId,
              Exception cause)

Fails the slot with the given allocation id and cause.

Parameters:

taskManagerId - identifying the task manager

allocationId - identifying the slot to fail

cause - of the failing

registerTaskManager

CompletableFuture<RegistrationResponse> registerTaskManager(String taskManagerRpcAddress,
                                                            TaskManagerLocation taskManagerLocation,
                                                            Time timeout)

Registers the task manager at the job manager.

Parameters:

taskManagerRpcAddress - the rpc address of the task manager

taskManagerLocation - location of the task manager

timeout - for the rpc call

Returns:

Future registration response indicating whether the registration was successful or not

heartbeatFromTaskManager

void heartbeatFromTaskManager(ResourceID resourceID)

Sends the heartbeat to job manager from task manager

Parameters:

resourceID - unique id of the task manager

heartbeatFromResourceManager

void heartbeatFromResourceManager(ResourceID resourceID)

Sends heartbeat request from the resource manager

Parameters:

resourceID - unique id of the resource manager

requestJobDetails

CompletableFuture<JobDetails> requestJobDetails(Time timeout)

Request the details of the executed job.

Parameters:

timeout - for the rpc call

Returns:

Future details of the executed job

requestArchivedExecutionGraph

CompletableFuture<AccessExecutionGraph> requestArchivedExecutionGraph(Time timeout)

Request the ArchivedExecutionGraph of the currently executed job.

Parameters:

timeout - for the rpc call

Returns:

Future archived execution graph derived from the currently executed job

requestJobStatus

CompletableFuture<JobStatus> requestJobStatus(Time timeout)

Requests the current job status.

Parameters:

timeout - for the rpc call

Returns:

Future containing the current job status