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
019 package org.apache.hadoop.yarn.api.protocolrecords;
020
021 import org.apache.hadoop.classification.InterfaceAudience.Public;
022 import org.apache.hadoop.classification.InterfaceStability.Unstable;
023 import org.apache.hadoop.yarn.api.ApplicationHistoryProtocol;
024 import org.apache.hadoop.yarn.api.records.ApplicationAttemptReport;
025 import org.apache.hadoop.yarn.util.Records;
026
027 /**
028 * <p>
029 * The response sent by the <code>ResourceManager</code> to a client requesting
030 * an application attempt report.
031 * </p>
032 *
033 * <p>
034 * The response includes an {@link ApplicationAttemptReport} which has the
035 * details about the particular application attempt
036 * </p>
037 *
038 * @see ApplicationAttemptReport
039 * @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)
040 */
041 @Public
042 @Unstable
043 public abstract class GetApplicationAttemptReportResponse {
044
045 @Public
046 @Unstable
047 public static GetApplicationAttemptReportResponse newInstance(
048 ApplicationAttemptReport ApplicationAttemptReport) {
049 GetApplicationAttemptReportResponse response =
050 Records.newRecord(GetApplicationAttemptReportResponse.class);
051 response.setApplicationAttemptReport(ApplicationAttemptReport);
052 return response;
053 }
054
055 /**
056 * Get the <code>ApplicationAttemptReport</code> for the application attempt.
057 *
058 * @return <code>ApplicationAttemptReport</code> for the application attempt
059 */
060 @Public
061 @Unstable
062 public abstract ApplicationAttemptReport getApplicationAttemptReport();
063
064 /**
065 * Get the <code>ApplicationAttemptReport</code> for the application attempt.
066 *
067 * @param applicationAttemptReport
068 * <code>ApplicationAttemptReport</code> for the application attempt
069 */
070 @Public
071 @Unstable
072 public abstract void setApplicationAttemptReport(
073 ApplicationAttemptReport applicationAttemptReport);
074 }