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