Package org.apache.hadoop.yarn.server.federation.store.records

Class GetApplicationHomeSubClusterRequest

java.lang.Object

org.apache.hadoop.yarn.server.federation.store.records.GetApplicationHomeSubClusterRequest

Direct Known Subclasses:

GetApplicationHomeSubClusterRequestPBImpl

@Private
@Unstable
public abstract class GetApplicationHomeSubClusterRequest
extends java.lang.Object

Request class to obtain the home sub-cluster for the specified ApplicationId.

Constructor Summary

Constructors

Constructor	Description
GetApplicationHomeSubClusterRequest()

Method Summary

Modifier and Type	Method	Description
abstract org.apache.hadoop.yarn.api.records.ApplicationId	getApplicationId()	Get the ApplicationId representing the unique identifier of the application.
abstract boolean	getContainsAppSubmissionContext()	Get the flag that indicates whether appSubmissionContext should be returned.
static GetApplicationHomeSubClusterRequest	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId appId)
static GetApplicationHomeSubClusterRequest	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId appId, boolean containsAppSubmissionContext)
abstract void	setApplicationId(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)	Set the ApplicationId representing the unique identifier of the application.
abstract void	setContainsAppSubmissionContext(boolean containsAppSubmissionContext)	Set the flag that indicates whether appSubmissionContext should be returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetApplicationHomeSubClusterRequest

public GetApplicationHomeSubClusterRequest()

Method Detail

newInstance

@Private
@Unstable
public static GetApplicationHomeSubClusterRequest newInstance(org.apache.hadoop.yarn.api.records.ApplicationId appId)

newInstance

@Private
@Unstable
public static GetApplicationHomeSubClusterRequest newInstance(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                                              boolean containsAppSubmissionContext)

getApplicationId

@Public
@Unstable
public abstract org.apache.hadoop.yarn.api.records.ApplicationId getApplicationId()

Get the ApplicationId representing the unique identifier of the application.

Returns:

the application identifier

setApplicationId

@Private
@Unstable
public abstract void setApplicationId(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Set the ApplicationId representing the unique identifier of the application.

Parameters:

applicationId - the application identifier

getContainsAppSubmissionContext

@Public
@Unstable
public abstract boolean getContainsAppSubmissionContext()

Get the flag that indicates whether appSubmissionContext should be returned. The reason for adding this variable is due to the consideration that appSubmissionContext is not commonly used and its data size can be large.

Returns:

whether to return appSubmissionContext.

setContainsAppSubmissionContext

@Public
@Unstable
public abstract void setContainsAppSubmissionContext(boolean containsAppSubmissionContext)

Set the flag that indicates whether appSubmissionContext should be returned.

Parameters:

containsAppSubmissionContext - whether to return appSubmissionContext.