branch-2.0.4-alpha/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetContainerStatusRequest.java

/**
 * 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.ContainerManager;
import org.apache.hadoop.yarn.api.records.ContainerId;
import org.apache.hadoop.yarn.api.records.ContainerStatus;

/**
 * <p>The request sent by the <code>ApplicationMaster</code> to the
 * <code>NodeManager</code> to get {@link ContainerStatus} of a container.</p>
 * 
 * @see ContainerManager#getContainerStatus(GetContainerStatusRequest)
 */
@Public
@Stable
public interface GetContainerStatusRequest {
  /**
   * Get the <code>ContainerId</code> of container for which to obtain the
   * <code>ContainerStatus</code>.
   * @return <code>ContainerId</code> of container for which to obtain the
   *         <code>ContainerStatus</code>
   */
  @Public
  @Stable
  public abstract ContainerId getContainerId();
  
  /**
   * Set the <code>ContainerId</code> of container for which to obtain the
   * <code>ContainerStatus</code>
   * @param containerId <code>ContainerId</code> of container for which to 
   *                    obtain the <code>ContainerStatus</code>
   */
  @Public
  @Stable
  public abstract void setContainerId(ContainerId containerId);
}