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.ApplicationClientProtocol;
026import org.apache.hadoop.yarn.api.records.ApplicationId;
027import org.apache.hadoop.yarn.api.records.Resource;
028import org.apache.hadoop.yarn.util.Records;
029
030/**
031 * <p>The response sent by the <code>ResourceManager</code> to the client for 
032 * a request to get a new {@link ApplicationId} for submitting applications.</p>
033 * 
034 * <p>Clients can submit an application with the returned
035 * {@link ApplicationId}.</p>
036 *
037 * @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)
038 */
039@Public
040@Stable
041public abstract class GetNewApplicationResponse {
042
043  @Private
044  @Unstable
045  public static GetNewApplicationResponse newInstance(
046      ApplicationId applicationId, Resource minCapability,
047      Resource maxCapability) {
048    GetNewApplicationResponse response =
049        Records.newRecord(GetNewApplicationResponse.class);
050    response.setApplicationId(applicationId);
051    response.setMaximumResourceCapability(maxCapability);
052    return response;
053  }
054
055  /**
056   * Get the <em>new</em> <code>ApplicationId</code> allocated by the 
057   * <code>ResourceManager</code>.
058   * @return <em>new</em> <code>ApplicationId</code> allocated by the 
059   *          <code>ResourceManager</code>
060   */
061  @Public
062  @Stable
063  public abstract ApplicationId getApplicationId();
064
065  @Private
066  @Unstable
067  public abstract void setApplicationId(ApplicationId applicationId);
068
069  /**
070   * Get the maximum capability for any {@link Resource} allocated by the 
071   * <code>ResourceManager</code> in the cluster.
072   * @return maximum capability of allocated resources in the cluster
073   */
074  @Public
075  @Stable
076  public abstract Resource getMaximumResourceCapability();
077  
078  @Private
079  @Unstable
080  public abstract void setMaximumResourceCapability(Resource capability); 
081}