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.ApplicationAttemptId;
025 import org.apache.hadoop.yarn.api.records.ApplicationAttemptReport;
026 import org.apache.hadoop.yarn.util.Records;
027
028 /**
029 * <p>
030 * The request sent by a client to the <code>ResourceManager</code> to get an
031 * {@link ApplicationAttemptReport} for an application attempt.
032 * </p>
033 *
034 * <p>
035 * The request should include the {@link ApplicationAttemptId} of the
036 * application attempt.
037 * </p>
038 *
039 * @see ApplicationAttemptReport
040 * @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)
041 */
042 @Public
043 @Unstable
044 public abstract class GetApplicationAttemptReportRequest {
045
046 @Public
047 @Unstable
048 public static GetApplicationAttemptReportRequest newInstance(
049 ApplicationAttemptId applicationAttemptId) {
050 GetApplicationAttemptReportRequest request =
051 Records.newRecord(GetApplicationAttemptReportRequest.class);
052 request.setApplicationAttemptId(applicationAttemptId);
053 return request;
054 }
055
056 /**
057 * Get the <code>ApplicationAttemptId</code> of an application attempt.
058 *
059 * @return <code>ApplicationAttemptId</code> of an application attempt
060 */
061 @Public
062 @Unstable
063 public abstract ApplicationAttemptId getApplicationAttemptId();
064
065 /**
066 * Set the <code>ApplicationAttemptId</code> of an application attempt
067 *
068 * @param applicationAttemptId
069 * <code>ApplicationAttemptId</code> of an application attempt
070 */
071 @Public
072 @Unstable
073 public abstract void setApplicationAttemptId(
074 ApplicationAttemptId applicationAttemptId);
075 }