org.apache.hadoop.yarn.server.api

Interface ResourceManagerAdministrationProtocol

All Superinterfaces:

org.apache.hadoop.tools.GetUserMappingsProtocol

@InterfaceAudience.Private
@InterfaceStability.Stable
public interface ResourceManagerAdministrationProtocol
extends org.apache.hadoop.tools.GetUserMappingsProtocol

Field Summary

Fields inherited from interface org.apache.hadoop.tools.GetUserMappingsProtocol

versionID

Method Summary

Methods

Modifier and Type	Method and Description
GetClusterNodeLabelsResponse	getClusterNodeLabels(GetClusterNodeLabelsRequest request)
RefreshAdminAclsResponse	refreshAdminAcls(RefreshAdminAclsRequest request)
RefreshClusterNodeLabelsResponse	refreshClusterNodeLabels(RefreshClusterNodeLabelsRequest request)
RefreshNodesResponse	refreshNodes(RefreshNodesRequest request)
RefreshQueuesResponse	refreshQueues(RefreshQueuesRequest request)
RefreshServiceAclsResponse	refreshServiceAcls(RefreshServiceAclsRequest request)
RefreshSuperUserGroupsConfigurationResponse	refreshSuperUserGroupsConfiguration(RefreshSuperUserGroupsConfigurationRequest request)
RefreshUserToGroupsMappingsResponse	refreshUserToGroupsMappings(RefreshUserToGroupsMappingsRequest request)
UpdateNodeResourceResponse	updateNodeResource(UpdateNodeResourceRequest request) The interface used by admin to update nodes' resources to the ResourceManager

Methods inherited from interface org.apache.hadoop.tools.GetUserMappingsProtocol

getGroupsForUser

Method Detail

refreshQueues

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshQueuesResponse refreshQueues(RefreshQueuesRequest request)
                                    throws org.apache.hadoop.ipc.StandbyException,
                                           YarnException,
                                           IOException

Throws:

org.apache.hadoop.ipc.StandbyException

YarnException

IOException

refreshNodes

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshNodesResponse refreshNodes(RefreshNodesRequest request)
                                  throws org.apache.hadoop.ipc.StandbyException,
                                         YarnException,
                                         IOException

Throws:

org.apache.hadoop.ipc.StandbyException

YarnException

IOException

refreshSuperUserGroupsConfiguration

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshSuperUserGroupsConfigurationResponse refreshSuperUserGroupsConfiguration(RefreshSuperUserGroupsConfigurationRequest request)
                                                                                throws org.apache.hadoop.ipc.StandbyException,
                                                                                       YarnException,
                                                                                       IOException

Throws:

org.apache.hadoop.ipc.StandbyException

YarnException

IOException

refreshUserToGroupsMappings

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshUserToGroupsMappingsResponse refreshUserToGroupsMappings(RefreshUserToGroupsMappingsRequest request)
                                                                throws org.apache.hadoop.ipc.StandbyException,
                                                                       YarnException,
                                                                       IOException

Throws:

org.apache.hadoop.ipc.StandbyException

YarnException

IOException

refreshAdminAcls

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshAdminAclsResponse refreshAdminAcls(RefreshAdminAclsRequest request)
                                          throws YarnException,
                                                 IOException

Throws:

YarnException

IOException

refreshServiceAcls

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshServiceAclsResponse refreshServiceAcls(RefreshServiceAclsRequest request)
                                              throws YarnException,
                                                     IOException

Throws:

YarnException

IOException

updateNodeResource

@InterfaceAudience.Public
@InterfaceStability.Evolving
UpdateNodeResourceResponse updateNodeResource(UpdateNodeResourceRequest request)
                                              throws YarnException,
                                                     IOException

The interface used by admin to update nodes' resources to the ResourceManager

.

The admin client is required to provide details such as a map from NodeId to ResourceOption required to update resources on a list of RMNode in ResourceManager etc. via the UpdateNodeResourceRequest.

Parameters:

request - request to update resource for a node in cluster.

Returns:

(empty) response on accepting update.

Throws:

YarnException

IOException

getClusterNodeLabels

@InterfaceAudience.Public
@InterfaceStability.Stable
GetClusterNodeLabelsResponse getClusterNodeLabels(GetClusterNodeLabelsRequest request)
                                                  throws YarnException,
                                                         IOException

Throws:

YarnException

IOException

refreshClusterNodeLabels

@InterfaceAudience.Public
@InterfaceStability.Stable
RefreshClusterNodeLabelsResponse refreshClusterNodeLabels(RefreshClusterNodeLabelsRequest request)
                                                          throws YarnException,
                                                                 IOException

Throws:

YarnException

IOException