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

Interface FederationReservationHomeSubClusterStore

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

The mapping details contains:

  • ReservationId
  • SubClusterId

  • Method Details

    • addReservationHomeSubCluster

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

    • getReservationHomeSubCluster

      GetReservationHomeSubClusterResponse getReservationHomeSubCluster(GetReservationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Get information about the Reservation identified by the input ReservationId.
      Parameters:
      request - contains the Reservation queried
      Returns:
      ReservationHomeSubCluster containing the Reservation's home subcluster
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • getReservationsHomeSubCluster

      GetReservationsHomeSubClusterResponse getReservationsHomeSubCluster(GetReservationsHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Get the ReservationHomeSubCluster list representing the mapping of all submitted Reservations to it's home sub-cluster.
      Parameters:
      request - empty representing all Reservations
      Returns:
      the mapping of all submitted Reservation to it's home sub-cluster
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

    • updateReservationHomeSubCluster

      UpdateReservationHomeSubClusterResponse updateReservationHomeSubCluster(UpdateReservationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Update the home SubClusterId of a previously submitted ReservationId. 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 a reservation.
      Returns:
      empty on successful update of the Reservation 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

    • deleteReservationHomeSubCluster

      DeleteReservationHomeSubClusterResponse deleteReservationHomeSubCluster(DeleteReservationHomeSubClusterRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException
      Delete the mapping of home SubClusterId of a previously submitted ReservationId. 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 a reservation.
      Returns:
      empty on successful update of the Reservation 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