org.apache.hadoop.yarn.api.records.impl.pb

Class ApplicationSubmissionContextPBImpl

java.lang.Object

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

org.apache.hadoop.yarn.api.records.impl.pb.ApplicationSubmissionContextPBImpl

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class ApplicationSubmissionContextPBImpl
extends ApplicationSubmissionContext

Constructor Summary

Constructors

Constructor and Description
ApplicationSubmissionContextPBImpl()
ApplicationSubmissionContextPBImpl(YarnProtos.ApplicationSubmissionContextProto proto)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
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.
String	getApplicationType() Get the application type
boolean	getCancelTokensWhenComplete()
int	getMaxAppAttempts()
Priority	getPriority() Get the Priority of the application.
YarnProtos.ApplicationSubmissionContextProto	getProto()
String	getQueue() Get the queue to which the application is being submitted.
Resource	getResource() Get the resource required by the ApplicationMaster for this application.
boolean	getUnmanagedAM() Get if the RM should manage the execution of the AM.
int	hashCode()
void	setAMContainerSpec(ContainerLaunchContext amContainer) Set the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.
void	setApplicationId(ApplicationId applicationId) Set the ApplicationId of the submitted application.
void	setApplicationName(String applicationName) Set the application name.
void	setApplicationType(String applicationType) Set the application type
void	setCancelTokensWhenComplete(boolean cancel) Set to false if tokens should not be canceled when the app finished else false.
void	setMaxAppAttempts(int maxAppAttempts) Set the number of max attempts of the application to be submitted.
void	setPriority(Priority priority) Set the Priority of the application.
void	setQueue(String queue) Set the queue to which the application is being submitted
void	setResource(Resource resource) Set the resource required by the ApplicationMaster for this application.
void	setUnmanagedAM(boolean value)
String	toString()

Methods inherited from class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext

newInstance, newInstance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationSubmissionContextPBImpl

public ApplicationSubmissionContextPBImpl()

ApplicationSubmissionContextPBImpl

public ApplicationSubmissionContextPBImpl(YarnProtos.ApplicationSubmissionContextProto proto)

Method Detail

getProto

public YarnProtos.ApplicationSubmissionContextProto getProto()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getPriority

public Priority getPriority()

Description copied from class: ApplicationSubmissionContext

Get the Priority of the application.

Specified by:

getPriority in class ApplicationSubmissionContext

Returns:

Priority of the application

setPriority

public void setPriority(Priority priority)

Description copied from class: ApplicationSubmissionContext

Set the Priority of the application.

Specified by:

setPriority in class ApplicationSubmissionContext

Parameters:

priority - Priority of the application

getApplicationId

public ApplicationId getApplicationId()

Description copied from class: ApplicationSubmissionContext

Get the ApplicationId of the submitted application.

Specified by:

getApplicationId in class ApplicationSubmissionContext

Returns:

ApplicationId of the submitted application

setApplicationId

public void setApplicationId(ApplicationId applicationId)

Description copied from class: ApplicationSubmissionContext

Set the ApplicationId of the submitted application.

Specified by:

setApplicationId in class ApplicationSubmissionContext

Parameters:

applicationId - ApplicationId of the submitted application

getApplicationName

public String getApplicationName()

Description copied from class: ApplicationSubmissionContext

Get the application name.

Specified by:

getApplicationName in class ApplicationSubmissionContext

Returns:

application name

setApplicationName

public void setApplicationName(String applicationName)

Description copied from class: ApplicationSubmissionContext

Set the application name.

Specified by:

setApplicationName in class ApplicationSubmissionContext

Parameters:

applicationName - application name

getQueue

public String getQueue()

Description copied from class: ApplicationSubmissionContext

Get the queue to which the application is being submitted.

Specified by:

getQueue in class ApplicationSubmissionContext

Returns:

queue to which the application is being submitted

getApplicationType

public String getApplicationType()

Description copied from class: ApplicationSubmissionContext

Get the application type

Specified by:

getApplicationType in class ApplicationSubmissionContext

Returns:

the application type

setQueue

public void setQueue(String queue)

Description copied from class: ApplicationSubmissionContext

Set the queue to which the application is being submitted

Specified by:

setQueue in class ApplicationSubmissionContext

Parameters:

queue - queue to which the application is being submitted

setApplicationType

public void setApplicationType(String applicationType)

Description copied from class: ApplicationSubmissionContext

Set the application type

Specified by:

setApplicationType in class ApplicationSubmissionContext

Parameters:

applicationType - the application type

getAMContainerSpec

public ContainerLaunchContext getAMContainerSpec()

Description copied from class: ApplicationSubmissionContext

Get the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.

Specified by:

getAMContainerSpec in class ApplicationSubmissionContext

Returns:

ContainerLaunchContext for the ApplicationMaster container

setAMContainerSpec

public void setAMContainerSpec(ContainerLaunchContext amContainer)

Description copied from class: ApplicationSubmissionContext

Set the ContainerLaunchContext to describe the Container with which the ApplicationMaster is launched.

Specified by:

setAMContainerSpec in class ApplicationSubmissionContext

Parameters:

amContainer - ContainerLaunchContext for the ApplicationMaster container

getUnmanagedAM

public boolean getUnmanagedAM()

Description copied from class: ApplicationSubmissionContext

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.

Specified by:

getUnmanagedAM in class ApplicationSubmissionContext

Returns:

true if the AM is not managed by the RM

setUnmanagedAM

public void setUnmanagedAM(boolean value)

Specified by:

setUnmanagedAM in class ApplicationSubmissionContext

Parameters:

value - true if RM should not manage the AM

getCancelTokensWhenComplete

public boolean getCancelTokensWhenComplete()

Specified by:

getCancelTokensWhenComplete in class ApplicationSubmissionContext

Returns:

true if tokens should be canceled when the app completes.

setCancelTokensWhenComplete

public void setCancelTokensWhenComplete(boolean cancel)

Description copied from class: ApplicationSubmissionContext

Set to false if tokens should not be canceled when the app finished else false. WARNING: this is not recommended unless you want your single job tokens to be reused by others jobs.

Specified by:

setCancelTokensWhenComplete in class ApplicationSubmissionContext

Parameters:

cancel - true if tokens should be canceled when the app finishes.

getMaxAppAttempts

public int getMaxAppAttempts()

Specified by:

getMaxAppAttempts in class ApplicationSubmissionContext

Returns:

the number of max attempts of the application to be submitted

setMaxAppAttempts

public void setMaxAppAttempts(int maxAppAttempts)

Description copied from class: ApplicationSubmissionContext

Set the number of max attempts of the application to be submitted. WARNING: it should be no larger than the global number of max attempts in the Yarn configuration.

Specified by:

setMaxAppAttempts in class ApplicationSubmissionContext

Parameters:

maxAppAttempts - the number of max attempts of the application to be submitted.

getResource

public Resource getResource()

Description copied from class: ApplicationSubmissionContext

Get the resource required by the ApplicationMaster for this application.

Specified by:

getResource in class ApplicationSubmissionContext

Returns:

the resource required by the ApplicationMaster for this application.

setResource

public void setResource(Resource resource)

Description copied from class: ApplicationSubmissionContext

Set the resource required by the ApplicationMaster for this application.

Specified by:

setResource in class ApplicationSubmissionContext

Parameters:

resource - the resource required by the ApplicationMaster for this application.