Package org.apache.hadoop.yarn.server.api

Interface DistributedSchedulingAMProtocol

All Superinterfaces:

org.apache.hadoop.yarn.api.ApplicationMasterProtocol

All Known Implementing Classes:

DistributedSchedulingAMProtocolPBClientImpl

public interface DistributedSchedulingAMProtocol
extends org.apache.hadoop.yarn.api.ApplicationMasterProtocol

This protocol extends the ApplicationMasterProtocol. It is used by the DistributedScheduler running on the NodeManager to wrap the request / response objects of the registerApplicationMaster and allocate methods of the protocol with additional information required to perform distributed scheduling.

Method Summary

Modifier and Type	Method	Description
DistributedSchedulingAllocateResponse	allocateForDistributedScheduling(DistributedSchedulingAllocateRequest request)	Extends the allocate to wrap the response with additional metadata.
RegisterDistributedSchedulingAMResponse	registerApplicationMasterForDistributedScheduling(org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest request)	Extends the registerApplicationMaster to wrap the response with additional metadata.

Methods inherited from interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol

allocate, finishApplicationMaster, registerApplicationMaster

Method Details

registerApplicationMasterForDistributedScheduling

@Public
@Unstable
RegisterDistributedSchedulingAMResponse registerApplicationMasterForDistributedScheduling(org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest request)
                                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Extends the registerApplicationMaster to wrap the response with additional metadata.

Parameters:

request - ApplicationMaster registration request

Returns:

A RegisterDistributedSchedulingAMResponse that contains a standard AM registration response along with additional information required for distributed scheduling

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YarnException

IOException - IOException

allocateForDistributedScheduling

@Public
@Unstable
DistributedSchedulingAllocateResponse allocateForDistributedScheduling(DistributedSchedulingAllocateRequest request)
                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Extends the allocate to wrap the response with additional metadata.

Parameters:

request - ApplicationMaster allocate request

Returns:

A DistributedSchedulingAllocateResponse that contains a standard AM allocate response along with additional information required for distributed scheduling

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YarnException

IOException - IOException