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.Public;
022import org.apache.hadoop.classification.InterfaceStability.Stable;
023import org.apache.hadoop.yarn.api.ClientRMProtocol;
024import org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext;
025import org.apache.hadoop.yarn.api.records.ContainerLaunchContext;
026import org.apache.hadoop.yarn.api.records.Resource;
027
028/**
029 * <p>The request sent by a client to <em>submit an application</em> to the 
030 * <code>ResourceManager</code>.</p>
031 * 
032 * <p>The request, via {@link ApplicationSubmissionContext}, contains
033 * details such as queue, {@link Resource} required to run the 
034 * <code>ApplicationMaster</code>, the equivalent of 
035 * {@link ContainerLaunchContext} for launching the 
036 * <code>ApplicationMaster</code> etc.
037 * 
038 * @see ClientRMProtocol#submitApplication(SubmitApplicationRequest)
039 */
040@Public
041@Stable
042public interface SubmitApplicationRequest {
043  /**
044   * Get the <code>ApplicationSubmissionContext</code> for the application.
045   * @return <code>ApplicationSubmissionContext</code> for the application
046   */
047  @Public
048  @Stable
049  public abstract ApplicationSubmissionContext getApplicationSubmissionContext();
050
051  /**
052   * Set the <code>ApplicationSubmissionContext</code> for the application.
053   * @param context <code>ApplicationSubmissionContext</code> for the 
054   *                application
055   */
056  @Public
057  @Stable
058  public abstract void setApplicationSubmissionContext(
059      ApplicationSubmissionContext context);
060}