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
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Unstable;
023import org.apache.hadoop.yarn.api.records.ContainerId;
024import org.apache.hadoop.yarn.api.records.ContainerReport;
025import org.apache.hadoop.yarn.util.Records;
026
027/**
028 * <p>
029 * The request sent by a client to the <code>ResourceManager</code> to get an
030 * {@link ContainerReport} for a container.
031 * </p>
032 */
033@Public
034@Unstable
035public abstract class GetContainerReportRequest {
036
037  @Public
038  @Unstable
039  public static GetContainerReportRequest newInstance(ContainerId containerId) {
040    GetContainerReportRequest request =
041        Records.newRecord(GetContainerReportRequest.class);
042    request.setContainerId(containerId);
043    return request;
044  }
045
046  /**
047   * Get the <code>ContainerId</code> of the Container.
048   * 
049   * @return <code>ContainerId</code> of the Container
050   */
051  @Public
052  @Unstable
053  public abstract ContainerId getContainerId();
054
055  /**
056   * Set the <code>ContainerId</code> of the container
057   * 
058   * @param containerId
059   *          <code>ContainerId</code> of the container
060   */
061  @Public
062  @Unstable
063  public abstract void setContainerId(ContainerId containerId);
064}