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.Private;
022import org.apache.hadoop.classification.InterfaceAudience.Public;
023import org.apache.hadoop.classification.InterfaceStability.Stable;
024import org.apache.hadoop.classification.InterfaceStability.Unstable;
025import org.apache.hadoop.yarn.api.ClientRMProtocol;
026import org.apache.hadoop.yarn.api.records.ApplicationId;
027import org.apache.hadoop.yarn.api.records.Resource;
028
029/**
030 * <p>The response sent by the <code>ResourceManager</code> to the client for 
031 * a request to get a new {@link ApplicationId} for submitting applications.</p>
032 * 
033 * @see ClientRMProtocol#getNewApplication(GetNewApplicationRequest)
034 */
035@Public
036@Stable
037public interface GetNewApplicationResponse {
038  /**
039   * Get the <em>new</em> <code>ApplicationId</code> allocated by the 
040   * <code>ResourceManager</code>.
041   * @return <em>new</em> <code>ApplicationId</code> allocated by the 
042   *          <code>ResourceManager</code>
043   */
044  @Public
045  @Stable
046  public abstract ApplicationId getApplicationId();
047
048  @Private
049  @Unstable
050  public abstract void setApplicationId(ApplicationId applicationId);
051  
052  /**
053   * Get the minimum capability for any {@link Resource} allocated by the 
054   * <code>ResourceManager</code> in the cluster.
055   * @return minimum capability of allocated resources in the cluster
056   */
057  @Public
058  @Stable
059  public Resource getMinimumResourceCapability();
060  
061  @Private
062  @Unstable
063  public void setMinimumResourceCapability(Resource capability);
064  
065  /**
066   * Get the maximum capability for any {@link Resource} allocated by the 
067   * <code>ResourceManager</code> in the cluster.
068   * @return maximum capability of allocated resources in the cluster
069   */
070  @Public
071  @Stable
072  public Resource getMaximumResourceCapability();
073  
074  @Private
075  @Unstable
076  public void setMaximumResourceCapability(Resource capability); 
077}