Package org.apache.hadoop.yarn.api.protocolrecords

Class GetNewApplicationResponse

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse

@Public
@Stable
public abstract class GetNewApplicationResponse
extends java.lang.Object

The response sent by the ResourceManager to the client for a request to get a new ApplicationId for submitting applications.

Clients can submit an application with the returned ApplicationId.

See Also:

ApplicationClientProtocol.getNewApplication(GetNewApplicationRequest)

Constructor Summary

Constructors

Constructor	Description
GetNewApplicationResponse()

Method Summary

Modifier and Type	Method	Description
abstract ApplicationId	getApplicationId()	Get the new ApplicationId allocated by the ResourceManager.
abstract Resource	getMaximumResourceCapability()	Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.
static GetNewApplicationResponse	newInstance(ApplicationId applicationId, Resource minCapability, Resource maxCapability)
abstract void	setApplicationId(ApplicationId applicationId)
abstract void	setMaximumResourceCapability(Resource capability)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetNewApplicationResponse

public GetNewApplicationResponse()

Method Detail

newInstance

@Private
@Unstable
public static GetNewApplicationResponse newInstance(ApplicationId applicationId,
                                                    Resource minCapability,
                                                    Resource maxCapability)

getApplicationId

@Public
@Stable
public abstract ApplicationId getApplicationId()

Get the new ApplicationId allocated by the ResourceManager.

Returns:

new ApplicationId allocated by the ResourceManager

setApplicationId

@Private
@Unstable
public abstract void setApplicationId(ApplicationId applicationId)

getMaximumResourceCapability

@Public
@Stable
public abstract Resource getMaximumResourceCapability()

Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.

Returns:

maximum capability of allocated resources in the cluster

setMaximumResourceCapability

@Private
@Unstable
public abstract void setMaximumResourceCapability(Resource capability)