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.Stable;
023import org.apache.hadoop.yarn.api.ContainerManager;
024import org.apache.hadoop.yarn.api.records.ContainerId;
025
026/**
027 * <p>The request sent by the <code>ApplicationMaster</code> to the
028 * <code>NodeManager</code> to <em>stop</em> a container.</p>
029 * 
030 * @see ContainerManager#stopContainer(StopContainerRequest)
031 */
032@Public
033@Stable
034public interface StopContainerRequest {
035  /**
036   * Get the <code>ContainerId</code> of the container to be stopped.
037   * @return <code>ContainerId</code> of container to be stopped
038   */
039  @Public
040  @Stable
041  ContainerId getContainerId();
042  
043  /**
044   * Set the <code>ContainerId</code> of the container to be stopped.
045   * @param containerId <code>ContainerId</code> of the container to be stopped
046   */
047  @Public
048  @Stable
049  void setContainerId(ContainerId containerId);
050}