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.ClientRMProtocol; 026import org.apache.hadoop.yarn.api.records.YarnClusterMetrics; 027 028/** 029 * <p>The response sent by the <code>ResourceManager</code> to a client 030 * requesting cluster metrics.<p> 031 * 032 * @see YarnClusterMetrics 033 * @see ClientRMProtocol#getClusterMetrics(GetClusterMetricsRequest) 034 */ 035@Public 036@Stable 037public interface GetClusterMetricsResponse { 038 /** 039 * Get the <code>YarnClusterMetrics</code> for the cluster. 040 * @return <code>YarnClusterMetrics</code> for the cluster 041 */ 042 @Public 043 @Stable 044 public YarnClusterMetrics getClusterMetrics(); 045 046 @Private 047 @Unstable 048 public void setClusterMetrics(YarnClusterMetrics metrics); 049}