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