org.apache.hadoop.yarn.api.records
Interface ApplicationSubmissionContext


@InterfaceAudience.Public
@InterfaceStability.Stable
public interface ApplicationSubmissionContext

ApplicationSubmissionContext represents all of the information needed by the ResourceManager to launch the ApplicationMaster for an application.

It includes details such as:

See Also:
ContainerLaunchContext, ClientRMProtocol.submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)

Method Summary
 ContainerLaunchContext getAMContainerSpec()
          Get the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.
 ApplicationId getApplicationId()
          Get the ApplicationId of the submitted application.
 String getApplicationName()
          Get the application name.
 org.apache.hadoop.yarn.api.records.Priority getPriority()
          Get the Priority of the application.
 String getQueue()
          Get the queue to which the application is being submitted.
 boolean getUnmanagedAM()
          Get if the RM should manage the execution of the AM.
 String getUser()
          Get the user submitting the application.
 void setAMContainerSpec(ContainerLaunchContext amContainer)
          Set the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.
 void setApplicationId(ApplicationId appplicationId)
          Set the ApplicationId of the submitted application.
 void setApplicationName(String applicationName)
          Set the application name.
 void setPriority(org.apache.hadoop.yarn.api.records.Priority priority)
          Set the Priority of the application.
 void setQueue(String queue)
          Set the queue to which the application is being submitted
 void setUnmanagedAM(boolean value)
           
 void setUser(String user)
          Set the user submitting the application.
 

Method Detail

getApplicationId

@InterfaceAudience.Public
@InterfaceStability.Stable
ApplicationId getApplicationId()
Get the ApplicationId of the submitted application.

Returns:
ApplicationId of the submitted application

setApplicationId

@InterfaceAudience.Public
@InterfaceStability.Stable
void setApplicationId(ApplicationId appplicationId)
Set the ApplicationId of the submitted application.

Parameters:
appplicationId - ApplicationId of the submitted application

getApplicationName

@InterfaceAudience.Public
@InterfaceStability.Stable
String getApplicationName()
Get the application name.

Returns:
application name

setApplicationName

@InterfaceAudience.Public
@InterfaceStability.Stable
void setApplicationName(String applicationName)
Set the application name.

Parameters:
applicationName - application name

getQueue

@InterfaceAudience.Public
@InterfaceStability.Stable
String getQueue()
Get the queue to which the application is being submitted.

Returns:
queue to which the application is being submitted

setQueue

@InterfaceAudience.Public
@InterfaceStability.Stable
void setQueue(String queue)
Set the queue to which the application is being submitted

Parameters:
queue - queue to which the application is being submitted

getPriority

@InterfaceAudience.Public
@InterfaceStability.Stable
org.apache.hadoop.yarn.api.records.Priority getPriority()
Get the Priority of the application.

Returns:
Priority of the application

setPriority

@InterfaceAudience.Public
@InterfaceStability.Stable
void setPriority(org.apache.hadoop.yarn.api.records.Priority priority)
Set the Priority of the application.

Parameters:
priority - Priority of the application

getUser

@InterfaceAudience.Public
@InterfaceStability.Stable
String getUser()
Get the user submitting the application.

Returns:
user submitting the application

setUser

@InterfaceAudience.Public
@InterfaceStability.Stable
void setUser(String user)
Set the user submitting the application.

Parameters:
user - user submitting the application

getAMContainerSpec

@InterfaceAudience.Public
@InterfaceStability.Stable
ContainerLaunchContext getAMContainerSpec()
Get the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.

Returns:
ContainerLaunchContext for the ApplicationMaster container

setAMContainerSpec

@InterfaceAudience.Public
@InterfaceStability.Stable
void setAMContainerSpec(ContainerLaunchContext amContainer)
Set the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.

Parameters:
amContainer - ContainerLaunchContext for the ApplicationMaster container

getUnmanagedAM

@InterfaceAudience.Public
@InterfaceStability.Unstable
boolean getUnmanagedAM()
Get if the RM should manage the execution of the AM. If true, then the RM will not allocate a container for the AM and start it. It will expect the AM to be launched and connect to the RM within the AM liveliness period and fail the app otherwise. The client should launch the AM only after the RM has ACCEPTED the application and changed the YarnApplicationState. Such apps will not be retried by the RM on app attempt failure. The default value is false.

Returns:
true if the AM is not managed by the RM

setUnmanagedAM

@InterfaceAudience.Public
@InterfaceStability.Unstable
void setUnmanagedAM(boolean value)
Parameters:
value - true if RM should not manage the AM


Copyright © 2012 Apache Software Foundation. All Rights Reserved.