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 java.util.List;
022    
023    import org.apache.hadoop.classification.InterfaceAudience.Private;
024    import org.apache.hadoop.classification.InterfaceAudience.Public;
025    import org.apache.hadoop.classification.InterfaceStability.Stable;
026    import org.apache.hadoop.classification.InterfaceStability.Unstable;
027    import org.apache.hadoop.yarn.api.ClientRMProtocol;
028    import org.apache.hadoop.yarn.api.records.ApplicationReport;
029    
030    /**
031     * <p>The response sent by the <code>ResourceManager</code> to a client
032     * requesting an {@link ApplicationReport} for all applications.</p>
033     * 
034     * <p>The <code>ApplicationReport</code> for each application includes details 
035     * such as user, queue, name, host on which the <code>ApplicationMaster</code> 
036     * is running, RPC port, tracking URL, diagnostics, start time etc.</p>
037     * 
038     * @see ApplicationReport
039     * @see ClientRMProtocol#getAllApplications(GetAllApplicationsRequest)
040     */
041    @Public
042    @Stable
043    public interface GetAllApplicationsResponse {
044      /**
045       * Get <code>ApplicationReport</code> for all applications.
046       * @return <code>ApplicationReport</code> for all applications
047       */
048      @Public
049      @Stable
050      List<ApplicationReport> getApplicationList();
051      
052      @Private
053      @Unstable
054      void setApplicationList(List<ApplicationReport> applications);
055    }