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.records.ContainerReport;
024 import org.apache.hadoop.yarn.util.Records;
025
026 /**
027 * <p>
028 * The response sent by the <code>ResourceManager</code> to a client requesting
029 * a container report.
030 * </p>
031 *
032 * <p>
033 * The response includes a {@link ContainerReport} which has details of a
034 * container.
035 * </p>
036 *
037 */
038 @Public
039 @Unstable
040 public abstract class GetContainerReportResponse {
041 @Public
042 @Unstable
043 public static GetContainerReportResponse newInstance(
044 ContainerReport containerReport) {
045 GetContainerReportResponse response =
046 Records.newRecord(GetContainerReportResponse.class);
047 response.setContainerReport(containerReport);
048 return response;
049 }
050
051 /**
052 * Get the <code>ContainerReport</code> for the container.
053 *
054 * @return <code>ContainerReport</code> for the container
055 */
056 @Public
057 @Unstable
058 public abstract ContainerReport getContainerReport();
059
060 @Public
061 @Unstable
062 public abstract void setContainerReport(ContainerReport containerReport);
063 }