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 org.apache.hadoop.classification.InterfaceAudience.Private; 022import org.apache.hadoop.classification.InterfaceAudience.Public; 023import org.apache.hadoop.classification.InterfaceStability.Stable; 024import org.apache.hadoop.classification.InterfaceStability.Unstable; 025import org.apache.hadoop.yarn.api.ApplicationClientProtocol; 026import org.apache.hadoop.yarn.api.records.YarnClusterMetrics; 027import org.apache.hadoop.yarn.util.Records; 028 029/** 030 * The response sent by the <code>ResourceManager</code> to a client 031 * requesting cluster metrics. 032 * 033 * @see YarnClusterMetrics 034 * @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest) 035 */ 036@Public 037@Stable 038public abstract class GetClusterMetricsResponse { 039 040 @Private 041 @Unstable 042 public static GetClusterMetricsResponse 043 newInstance(YarnClusterMetrics metrics) { 044 GetClusterMetricsResponse response = 045 Records.newRecord(GetClusterMetricsResponse.class); 046 response.setClusterMetrics(metrics); 047 return response; 048 } 049 050 /** 051 * Get the <code>YarnClusterMetrics</code> for the cluster. 052 * @return <code>YarnClusterMetrics</code> for the cluster 053 */ 054 @Public 055 @Stable 056 public abstract YarnClusterMetrics getClusterMetrics(); 057 058 @Private 059 @Unstable 060 public abstract void setClusterMetrics(YarnClusterMetrics metrics); 061}