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

Interface SCMUploaderProtocol

All Known Implementing Classes:
SCMUploaderProtocolPBClientImpl
@Private @Unstable public interface SCMUploaderProtocol

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

  • Method Details

    • notify

      SCMUploaderNotifyResponse notify(SCMUploaderNotifyRequest request) throws org.apache.hadoop.yarn.exceptions.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:
      org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.
      IOException - if there are I/O errors.

    • canUpload

      SCMUploaderCanUploadResponse canUpload(SCMUploaderCanUploadRequest request) throws org.apache.hadoop.yarn.exceptions.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:
      org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.
      IOException - if there are I/O errors.