org.apache.hadoop.yarn.server.api

Interface SCMUploaderProtocol

All Known Implementing Classes:

SCMUploaderProtocolPBClientImpl

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public interface SCMUploaderProtocol

The protocol between a NodeManager's SharedCacheUploadService and the SharedCacheManager.

Method Summary

Modifier and Type	Method and Description
SCMUploaderCanUploadResponse	canUpload(SCMUploaderCanUploadRequest request) The method used by the NodeManager's SharedCacheUploadService to request whether a resource can be uploaded.
SCMUploaderNotifyResponse	notify(SCMUploaderNotifyRequest request) The method used by the NodeManager's SharedCacheUploadService to notify the shared cache manager of a newly cached resource.

Method Detail

notify

SCMUploaderNotifyResponse notify(SCMUploaderNotifyRequest request)
                          throws YarnException,
                                 IOException

The method used by the NodeManager's SharedCacheUploadService to notify the shared cache manager of a newly cached resource.

The SharedCacheManager responds with whether or not the NodeManager should delete the uploaded file.

Parameters:

request - notify the shared cache manager of a newly uploaded resource to the shared cache

Returns:

response indicating if the newly uploaded resource should be deleted

Throws:

YarnException

IOException

canUpload

SCMUploaderCanUploadResponse canUpload(SCMUploaderCanUploadRequest request)
                                throws YarnException,
                                       IOException

The method used by the NodeManager's SharedCacheUploadService to request whether a resource can be uploaded.

The SharedCacheManager responds with whether or not the NodeManager can upload the file.

Parameters:

request - whether the resource can be uploaded to the shared cache

Returns:

response indicating if resource can be uploaded to the shared cache

Throws:

YarnException

IOException