hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/YarnClusterMetrics.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.yarn.api.records;

import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.util.Records;

/**
 * <p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
 * 
 * <p>Currently only number of <code>NodeManager</code>s is provided.</p>
 */
@Public
@Stable
public abstract class YarnClusterMetrics {
  
  @Private
  @Unstable
  public static YarnClusterMetrics newInstance(int numNodeManagers) {
    YarnClusterMetrics metrics = Records.newRecord(YarnClusterMetrics.class);
    metrics.setNumNodeManagers(numNodeManagers);
    return metrics;
  }

  /**
   * Get the number of <code>NodeManager</code>s in the cluster.
   * @return number of <code>NodeManager</code>s in the cluster
   */
  @Public
  @Stable
  public abstract int getNumNodeManagers();

  @Private
  @Unstable
  public abstract void setNumNodeManagers(int numNodeManagers);

  /**
   * Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
   * 
   * @return number of <code>DecommissionedNodeManager</code>s in the cluster
   */
  @Public
  @Unstable
  public abstract int getNumDecommissionedNodeManagers();

  @Private
  @Unstable
  public abstract void setNumDecommissionedNodeManagers(
      int numDecommissionedNodeManagers);

  /**
   * Get the number of <code>ActiveNodeManager</code>s in the cluster.
   * 
   * @return number of <code>ActiveNodeManager</code>s in the cluster
   */
  @Public
  @Unstable
  public abstract int getNumActiveNodeManagers();

  @Private
  @Unstable
  public abstract void setNumActiveNodeManagers(int numActiveNodeManagers);

  /**
   * Get the number of <code>LostNodeManager</code>s in the cluster.
   * 
   * @return number of <code>LostNodeManager</code>s in the cluster
   */
  @Public
  @Unstable
  public abstract int getNumLostNodeManagers();

  @Private
  @Unstable
  public abstract void setNumLostNodeManagers(int numLostNodeManagers);

  /**
   * Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
   * 
   * @return number of <code>UnhealthyNodeManager</code>s in the cluster
   */
  @Public
  @Unstable
  public abstract int getNumUnhealthyNodeManagers();

  @Private
  @Unstable
  public abstract void setNumUnhealthyNodeManagers(int numUnhealthNodeManagers);

  /**
   * Get the number of <code>RebootedNodeManager</code>s in the cluster.
   * 
   * @return number of <code>RebootedNodeManager</code>s in the cluster
   */
  @Public
  @Unstable
  public abstract int getNumRebootedNodeManagers();

  @Private
  @Unstable
  public abstract void setNumRebootedNodeManagers(int numRebootedNodeManagers);

}