org.apache.hadoop.yarn.server.api

Interface ResourceManagerAdministrationProtocol

All Superinterfaces:

GetUserMappingsProtocol

@InterfaceAudience.Private
 @InterfaceStability.Stable
public interface ResourceManagerAdministrationProtocol
extends GetUserMappingsProtocol

Field Summary

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

versionID

Method Summary

Modifier and Type	Method and Description
AddToClusterNodeLabelsResponse	addToClusterNodeLabels(AddToClusterNodeLabelsRequest request)
RefreshAdminAclsResponse	refreshAdminAcls(RefreshAdminAclsRequest request)
RefreshNodesResponse	refreshNodes(RefreshNodesRequest request)
RefreshQueuesResponse	refreshQueues(RefreshQueuesRequest request)
RefreshServiceAclsResponse	refreshServiceAcls(RefreshServiceAclsRequest request)
RefreshSuperUserGroupsConfigurationResponse	refreshSuperUserGroupsConfiguration(RefreshSuperUserGroupsConfigurationRequest request)
RefreshUserToGroupsMappingsResponse	refreshUserToGroupsMappings(RefreshUserToGroupsMappingsRequest request)
RemoveFromClusterNodeLabelsResponse	removeFromClusterNodeLabels(RemoveFromClusterNodeLabelsRequest request)
ReplaceLabelsOnNodeResponse	replaceLabelsOnNode(ReplaceLabelsOnNodeRequest 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

addToClusterNodeLabels

@InterfaceAudience.Public
 @InterfaceStability.Evolving
AddToClusterNodeLabelsResponse addToClusterNodeLabels(AddToClusterNodeLabelsRequest request)
                                                                                                       throws YarnException,
                                                                                                              IOException

Throws:

YarnException

IOException

removeFromClusterNodeLabels

@InterfaceAudience.Public
 @InterfaceStability.Evolving
RemoveFromClusterNodeLabelsResponse removeFromClusterNodeLabels(RemoveFromClusterNodeLabelsRequest request)
                                                                                                                 throws YarnException,
                                                                                                                        IOException

Throws:

YarnException

IOException

replaceLabelsOnNode

@InterfaceAudience.Public
 @InterfaceStability.Evolving
ReplaceLabelsOnNodeResponse replaceLabelsOnNode(ReplaceLabelsOnNodeRequest request)
                                                                                                 throws YarnException,
                                                                                                        IOException

Throws:

YarnException

IOException