Package org.apache.hadoop.yarn.server.federation.store

Interface FederationApplicationHomeSubClusterStore

All Known Subinterfaces:
FederationStateStore
All Known Implementing Classes:
MemoryFederationStateStore, SQLFederationStateStore, ZookeeperFederationStateStore
@Private @Unstable public interface FederationApplicationHomeSubClusterStore
FederationApplicationHomeSubClusterStore maintains the state of all Applications that have been submitted to the federated cluster. *

The mapping details contains:

  • ApplicationId
  • SubClusterId

  • Method Details

    • addApplicationHomeSubCluster

      AddApplicationHomeSubClusterResponse addApplicationHomeSubCluster(AddApplicationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Register the home SubClusterId of the newly submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure. If a mapping for the application already existed, the SubClusterId in this response will return the existing mapping which might be different from that in the AddApplicationHomeSubClusterRequest.
      Parameters:
      request - the request to register a new application with its home sub-cluster
      Returns:
      upon successful registration of the application in the StateStore, AddApplicationHomeSubClusterRequest containing the home sub-cluster of the application. Otherwise, an exception reporting reason for a failure
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • updateApplicationHomeSubCluster

      UpdateApplicationHomeSubClusterResponse updateApplicationHomeSubCluster(UpdateApplicationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Update the home SubClusterId of a previously submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.
      Parameters:
      request - the request to update the home sub-cluster of an application.
      Returns:
      empty on successful update of the application in the StateStore, if not an exception reporting reason for a failure
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • getApplicationHomeSubCluster

      GetApplicationHomeSubClusterResponse getApplicationHomeSubCluster(GetApplicationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Get information about the application identified by the input ApplicationId.
      Parameters:
      request - contains the application queried
      Returns:
      ApplicationHomeSubCluster containing the application's home subcluster
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • getApplicationsHomeSubCluster

      GetApplicationsHomeSubClusterResponse getApplicationsHomeSubCluster(GetApplicationsHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Get the ApplicationHomeSubCluster list representing the mapping of all submitted applications to it's home sub-cluster.
      Parameters:
      request - empty representing all applications
      Returns:
      the mapping of all submitted application to it's home sub-cluster
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • deleteApplicationHomeSubCluster

      DeleteApplicationHomeSubClusterResponse deleteApplicationHomeSubCluster(DeleteApplicationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Delete the mapping of home SubClusterId of a previously submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.
      Parameters:
      request - the request to delete the home sub-cluster of an application.
      Returns:
      empty on successful update of the application in the StateStore, if not an exception reporting reason for a failure
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails