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

Class SubClusterInfo

java.lang.Object
org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo
Direct Known Subclasses:
SubClusterInfoPBImpl
@Private @Unstable public abstract class SubClusterInfo extends Object

SubClusterInfo is a report of the runtime information of the subcluster that is participating in federation.

It includes information such as:

  • SubClusterId
  • The URL of the subcluster
  • The timestamp representing the last start time of the subCluster
  • FederationsubClusterState
  • The current capacity and utilization of the subCluster

  • Constructor Details

    • SubClusterInfo

      public SubClusterInfo()

  • Method Details

    • newInstance

      @Private @Unstable public static SubClusterInfo newInstance(SubClusterId subClusterId, String amRMServiceAddress, String clientRMServiceAddress, String rmAdminServiceAddress, String rmWebServiceAddress, SubClusterState state, long lastStartTime, String capability)

    • newInstance

      @Private @Unstable public static SubClusterInfo newInstance(SubClusterId subClusterId, String amRMServiceAddress, String clientRMServiceAddress, String rmAdminServiceAddress, String rmWebServiceAddress, long lastHeartBeat, SubClusterState state, long lastStartTime, String capability)

    • newInstance

      public static SubClusterInfo newInstance(SubClusterId subClusterId, String rmWebServiceAddress, SubClusterState state, long lastStartTime, long lastHeartBeat, String capability)

    • getSubClusterId

      @Public @Unstable public abstract SubClusterId getSubClusterId()
      Get the SubClusterId representing the unique identifier of the subcluster.
      Returns:
      the subcluster identifier

    • setSubClusterId

      @Private @Unstable public abstract void setSubClusterId(SubClusterId subClusterId)
      Set the SubClusterId representing the unique identifier of the subCluster.
      Parameters:
      subClusterId - the subCluster identifier

    • getAMRMServiceAddress

      @Public @Unstable public abstract String getAMRMServiceAddress()
      Get the URL of the AM-RM service endpoint of the subcluster ResourceManager.
      Returns:
      the URL of the AM-RM service endpoint of the subcluster ResourceManager

    • setAMRMServiceAddress

      @Private @Unstable public abstract void setAMRMServiceAddress(String amRMServiceAddress)
      Set the URL of the AM-RM service endpoint of the subcluster ResourceManager.
      Parameters:
      amRMServiceAddress - the URL of the AM-RM service endpoint of the subcluster ResourceManager

    • getClientRMServiceAddress

      @Public @Unstable public abstract String getClientRMServiceAddress()
      Get the URL of the client-RM service endpoint of the subcluster ResourceManager.
      Returns:
      the URL of the client-RM service endpoint of the subcluster ResourceManager

    • setClientRMServiceAddress

      @Private @Unstable public abstract void setClientRMServiceAddress(String clientRMServiceAddress)
      Set the URL of the client-RM service endpoint of the subcluster ResourceManager.
      Parameters:
      clientRMServiceAddress - the URL of the client-RM service endpoint of the subCluster ResourceManager

    • getRMAdminServiceAddress

      @Public @Unstable public abstract String getRMAdminServiceAddress()
      Get the URL of the ResourceManager administration service.
      Returns:
      the URL of the ResourceManager administration service

    • setRMAdminServiceAddress

      @Private @Unstable public abstract void setRMAdminServiceAddress(String rmAdminServiceAddress)
      Set the URL of the ResourceManager administration service.
      Parameters:
      rmAdminServiceAddress - the URL of the ResourceManager administration service.

    • getRMWebServiceAddress

      @Public @Unstable public abstract String getRMWebServiceAddress()
      Get the URL of the ResourceManager web application interface.
      Returns:
      the URL of the ResourceManager web application interface.

    • setRMWebServiceAddress

      @Private @Unstable public abstract void setRMWebServiceAddress(String rmWebServiceAddress)
      Set the URL of the ResourceManager web application interface.
      Parameters:
      rmWebServiceAddress - the URL of the ResourceManager web application interface.

    • getLastHeartBeat

      @Public @Unstable public abstract long getLastHeartBeat()
      Get the last heart beat time of the subcluster.
      Returns:
      the state of the subcluster

    • setLastHeartBeat

      @Private @Unstable public abstract void setLastHeartBeat(long time)
      Set the last heartbeat time of the subcluster.
      Parameters:
      time - the last heartbeat time of the subcluster

    • getState

      @Public @Unstable public abstract SubClusterState getState()
      Get the SubClusterState of the subcluster.
      Returns:
      the state of the subcluster

    • setState

      @Private @Unstable public abstract void setState(SubClusterState state)
      Set the SubClusterState of the subcluster.
      Parameters:
      state - the state of the subCluster

    • getLastStartTime

      @Public @Unstable public abstract long getLastStartTime()
      Get the timestamp representing the last start time of the subcluster.
      Returns:
      the timestamp representing the last start time of the subcluster

    • setLastStartTime

      @Private @Unstable public abstract void setLastStartTime(long lastStartTime)
      Set the timestamp representing the last start time of the subcluster.
      Parameters:
      lastStartTime - the timestamp representing the last start time of the subcluster

    • getCapability

      @Public @Unstable public abstract String getCapability()
      Get the current capacity and utilization of the subcluster. This is the JAXB marshalled string representation of the ClusterMetrics.
      Returns:
      the current capacity and utilization of the subcluster

    • setCapability

      @Private @Unstable public abstract void setCapability(String capability)
      Set the current capacity and utilization of the subCluster. This is the JAXB marshalled string representation of the ClusterMetrics.
      Parameters:
      capability - the current capacity and utilization of the subcluster

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object