org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.yarn.api.protocolrecords;
import java.util.List;
import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
import org.apache.hadoop.yarn.api.records.ApplicationReport;
import org.apache.hadoop.yarn.util.Records;
/**
* The response sent by the ResourceManager
to a client
* requesting an {@link ApplicationReport} for applications.
*
* The ApplicationReport
for each application includes details
* such as user, queue, name, host on which the ApplicationMaster
* is running, RPC port, tracking URL, diagnostics, start time etc.
*
* @see ApplicationReport
* @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
*/
@Public
@Stable
public abstract class GetApplicationsResponse {
@Private
@Unstable
public static GetApplicationsResponse newInstance(
List applications) {
GetApplicationsResponse response =
Records.newRecord(GetApplicationsResponse.class);
response.setApplicationList(applications);
return response;
}
/**
* Get ApplicationReport
for applications.
* @return ApplicationReport
for applications
*/
@Public
@Stable
public abstract List getApplicationList();
@Private
@Unstable
public abstract void setApplicationList(List applications);
}