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.ApplicationId;
025    import org.apache.hadoop.yarn.util.Records;
026    
027    /**
028     * <p>
029     * The request from clients to get a list of application attempt reports of an
030     * application from the <code>ResourceManager</code>.
031     * </p>
032     * 
033     * @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)
034     */
035    @Public
036    @Unstable
037    public abstract class GetApplicationAttemptsRequest {
038    
039      @Public
040      @Unstable
041      public static GetApplicationAttemptsRequest newInstance(
042          ApplicationId applicationId) {
043        GetApplicationAttemptsRequest request =
044            Records.newRecord(GetApplicationAttemptsRequest.class);
045        request.setApplicationId(applicationId);
046        return request;
047      }
048    
049      /**
050       * Get the <code>ApplicationId</code> of an application
051       * 
052       * @return <code>ApplicationId</code> of an application
053       */
054      @Public
055      @Unstable
056      public abstract ApplicationId getApplicationId();
057    
058      /**
059       * Set the <code>ApplicationId</code> of an application
060       * 
061       * @param applicationId
062       *          <code>ApplicationId</code> of an application
063       */
064      @Public
065      @Unstable
066      public abstract void setApplicationId(ApplicationId applicationId);
067    }