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 java.util.List;
022
023import org.apache.hadoop.classification.InterfaceAudience.Public;
024import org.apache.hadoop.classification.InterfaceStability.Stable;
025import org.apache.hadoop.yarn.api.ContainerManagementProtocol;
026import org.apache.hadoop.yarn.api.records.ContainerId;
027import org.apache.hadoop.yarn.api.records.ContainerStatus;
028import org.apache.hadoop.yarn.util.Records;
029
030/**
031 * <p>
032 * The request sent by the <code>ApplicationMaster</code> to the
033 * <code>NodeManager</code> to get {@link ContainerStatus} of requested
034 * containers.
035 * </p>
036 * 
037 * @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)
038 */
039@Public
040@Stable
041public abstract class GetContainerStatusesRequest {
042
043  @Public
044  @Stable
045  public static GetContainerStatusesRequest newInstance(
046      List<ContainerId> containerIds) {
047    GetContainerStatusesRequest request =
048        Records.newRecord(GetContainerStatusesRequest.class);
049    request.setContainerIds(containerIds);
050    return request;
051  }
052
053  /**
054   * Get the list of <code>ContainerId</code>s of containers for which to obtain
055   * the <code>ContainerStatus</code>.
056   * 
057   * @return the list of <code>ContainerId</code>s of containers for which to
058   *         obtain the <code>ContainerStatus</code>.
059   */
060  @Public
061  @Stable
062  public abstract List<ContainerId> getContainerIds();
063
064  /**
065   * Set a list of <code>ContainerId</code>s of containers for which to obtain
066   * the <code>ContainerStatus</code>
067   * 
068   * @param containerIds
069   *          a list of <code>ContainerId</code>s of containers for which to
070   *          obtain the <code>ContainerStatus</code>
071   */
072  @Public
073  @Stable
074  public abstract void setContainerIds(List<ContainerId> containerIds);
075}