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