org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest 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 org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.ApplicationReport;
import org.apache.hadoop.yarn.util.Records;
/**
* The request sent by a client to the ResourceManager
to
* get an {@link ApplicationReport} for an application.
*
* The request should include the {@link ApplicationId} of the
* application.
*
* @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
* @see ApplicationReport
*/
@Public
@Stable
public abstract class GetApplicationReportRequest {
@Public
@Stable
public static GetApplicationReportRequest newInstance(
ApplicationId applicationId) {
GetApplicationReportRequest request =
Records.newRecord(GetApplicationReportRequest.class);
request.setApplicationId(applicationId);
return request;
}
/**
* Get the ApplicationId
of the application.
* @return ApplicationId
of the application
*/
@Public
@Stable
public abstract ApplicationId getApplicationId();
/**
* Set the ApplicationId
of the application
* @param applicationId ApplicationId
of the application
*/
@Public
@Stable
public abstract void setApplicationId(ApplicationId applicationId);
}