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

Interface SCMAdminProtocol

@Public
@Unstable
public interface SCMAdminProtocol

The protocol between administrators and the SharedCacheManager

Method Summary

Modifier and Type	Method	Description
RunSharedCacheCleanerTaskResponse	runCleanerTask(RunSharedCacheCleanerTaskRequest request)	The method used by administrators to ask SCM to run cleaner task right away

Method Detail

runCleanerTask

@Public
@Unstable
RunSharedCacheCleanerTaskResponse runCleanerTask(RunSharedCacheCleanerTaskRequest request)
                                          throws YarnException,
                                                 java.io.IOException

The method used by administrators to ask SCM to run cleaner task right away

Parameters:

request - request SharedCacheManager to run a cleaner task

Returns:

SharedCacheManager returns an empty response on success and throws an exception on rejecting the request

Throws:

YarnException - exceptions from yarn servers.

java.io.IOException - io error occur.