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.ApplicationReport;
027import org.apache.hadoop.yarn.util.Records;
028
029/**
030 * <p>The response sent by the <code>ResourceManager</code> to a client
031 * requesting an application report.</p>
032 * 
033 * <p>The response includes an {@link ApplicationReport} which has details such 
034 * as user, queue, name, host on which the <code>ApplicationMaster</code> is 
035 * running, RPC port, tracking URL, diagnostics, start time etc.</p>
036 * 
037 * @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
038 */
039@Public
040@Stable
041public abstract class GetApplicationReportResponse {
042
043  @Private
044  @Unstable
045  public static GetApplicationReportResponse newInstance(
046      ApplicationReport ApplicationReport) {
047    GetApplicationReportResponse response =
048        Records.newRecord(GetApplicationReportResponse.class);
049    response.setApplicationReport(ApplicationReport);
050    return response;
051  }
052
053  /**
054   * Get the <code>ApplicationReport</code> for the application.
055   * @return <code>ApplicationReport</code> for the application
056   */
057  @Public
058  @Stable
059  public abstract ApplicationReport getApplicationReport();
060  
061  @Private
062  @Unstable
063  public abstract void setApplicationReport(ApplicationReport ApplicationReport);
064}