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.ApplicationClientProtocol;
028import org.apache.hadoop.yarn.api.records.NodeReport;
029import org.apache.hadoop.yarn.util.Records;
030
031/**
032 * <p>The response sent by the <code>ResourceManager</code> to a client
033 * requesting a {@link NodeReport} for all nodes.</p>
034 * 
035 * <p>The <code>NodeReport</code> contains per-node information such as 
036 * available resources, number of containers, tracking url, rack name, health
037 * status etc.
038 * 
039 * @see NodeReport
040 * @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)
041 */
042@Public
043@Stable
044public abstract class GetClusterNodesResponse {
045
046  @Private
047  @Unstable
048  public static GetClusterNodesResponse
049      newInstance(List<NodeReport> nodeReports) {
050    GetClusterNodesResponse response =
051        Records.newRecord(GetClusterNodesResponse.class);
052    response.setNodeReports(nodeReports);
053    return response;
054  }
055
056  /**
057   * Get <code>NodeReport</code> for all nodes in the cluster.
058   * @return <code>NodeReport</code> for all nodes in the cluster
059   */
060  @Public
061  @Stable
062  public abstract List<NodeReport> getNodeReports();
063  
064  @Private
065  @Unstable
066  public abstract void setNodeReports(List<NodeReport> nodeReports);
067}