001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import java.util.List;
022
023import org.apache.hadoop.classification.InterfaceAudience.Private;
024import org.apache.hadoop.classification.InterfaceAudience.Public;
025import org.apache.hadoop.classification.InterfaceStability.Stable;
026import org.apache.hadoop.classification.InterfaceStability.Unstable;
027import org.apache.hadoop.yarn.api.ClientRMProtocol;
028import org.apache.hadoop.yarn.api.records.NodeReport;
029
030/**
031 * <p>The response sent by the <code>ResourceManager</code> to a client
032 * requesting a {@link NodeReport} for all nodes.</p>
033 * 
034 * <p>The <code>NodeReport</code> contains per-node information such as 
035 * available resources, number of containers, tracking url, rack name, health
036 * status etc.
037 * 
038 * @see NodeReport
039 * @see ClientRMProtocol#getClusterNodes(GetClusterNodesRequest)
040 */
041@Public
042@Stable
043public interface GetClusterNodesResponse {
044  /**
045   * Get <code>NodeReport</code> for all nodes in the cluster.
046   * @return <code>NodeReport</code> for all nodes in the cluster
047   */
048  @Public
049  @Stable
050  List<NodeReport> getNodeReports();
051  
052  @Private
053  @Unstable
054  void setNodeReports(List<NodeReport> nodeReports);
055}