org.apache.hadoop.yarn.api.protocolrecords
Class FinishApplicationMasterRequest

java.lang.Object
  org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class FinishApplicationMasterRequest
extends Object

The finalization request sent by the ApplicationMaster to inform the ResourceManager about its completion.

The final request includes details such:

• Final state of the ApplicationMaster
• Diagnostic information in case of failure of the ApplicationMaster
• Tracking URL

See Also:

ApplicationMasterProtocol.finishApplicationMaster(FinishApplicationMasterRequest)

Constructor Summary

FinishApplicationMasterRequest()

Method Summary

abstract String	getDiagnostics() Get diagnostic information on application failure.
abstract FinalApplicationStatus	getFinalApplicationStatus() Get final state of the ApplicationMaster.
abstract String	getTrackingUrl() Get the tracking URL for the ApplicationMaster.
static FinishApplicationMasterRequest	newInstance(FinalApplicationStatus finalAppStatus, String diagnostics, String url)
abstract void	setDiagnostics(String diagnostics) Set diagnostic information on application failure.
abstract void	setFinalApplicationStatus(FinalApplicationStatus finalState) Set the final state of the ApplicationMaster
abstract void	setTrackingUrl(String url) Set the tracking URLfor the ApplicationMaster

Methods inherited from class java.lang.Object

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

Constructor Detail

FinishApplicationMasterRequest

public FinishApplicationMasterRequest()

Method Detail

newInstance

@InterfaceAudience.Public
@InterfaceStability.Stable
public static FinishApplicationMasterRequest newInstance(FinalApplicationStatus finalAppStatus,
                                                                                                            String diagnostics,
                                                                                                            String url)

getFinalApplicationStatus

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract FinalApplicationStatus getFinalApplicationStatus()

Get final state of the ApplicationMaster.

Returns:

final state of the ApplicationMaster

setFinalApplicationStatus

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract void setFinalApplicationStatus(FinalApplicationStatus finalState)

Set the final state of the ApplicationMaster

Parameters:

finalState - final state of the ApplicationMaster

getDiagnostics

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract String getDiagnostics()

Get diagnostic information on application failure.

Returns:

diagnostic information on application failure

setDiagnostics

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract void setDiagnostics(String diagnostics)

Set diagnostic information on application failure.

Parameters:

diagnostics - diagnostic information on application failure

getTrackingUrl

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract String getTrackingUrl()

Get the tracking URL for the ApplicationMaster.

Returns:

tracking URLfor the ApplicationMaster

setTrackingUrl

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract void setTrackingUrl(String url)

Set the tracking URLfor the ApplicationMaster

Parameters:

url - tracking URLfor the ApplicationMaster