org.apache.hadoop.yarn.api.protocolrecords
Interface RegisterApplicationMasterRequest

All Known Implementing Classes:

RegisterApplicationMasterRequestPBImpl

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface RegisterApplicationMasterRequest

The request sent by the ApplicationMaster to ResourceManager on registration.

The registration includes details such as:

• ApplicationAttemptId being managed by the ApplicationMaster
• Hostname on which the AM is running.
• RPC Port
• Tracking URL

See Also:

AMRMProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)

Method Summary

ApplicationAttemptId	getApplicationAttemptId() Get the ApplicationAttemptId being managed by the ApplicationMaster.
String	getHost() Get the host on which the ApplicationMaster is running.
int	getRpcPort() Get the RPC port on which the ApplicationMaster is responding.
String	getTrackingUrl() Get the tracking URL for the ApplicationMaster.
void	setApplicationAttemptId(ApplicationAttemptId applicationAttemptId) Set the ApplicationAttemptId being managed by the ApplicationMaster.
void	setHost(String host) Set the host on which the ApplicationMaster is running.
void	setRpcPort(int port) Set the RPC port on which the ApplicationMaster is responding.
void	setTrackingUrl(String trackingUrl) Set the tracking URL for the ApplicationMaster.

Method Detail

getApplicationAttemptId

@InterfaceAudience.Public
@InterfaceStability.Stable
ApplicationAttemptId getApplicationAttemptId()

Get the ApplicationAttemptId being managed by the ApplicationMaster.

Returns:

ApplicationAttemptId being managed by the ApplicationMaster

setApplicationAttemptId

@InterfaceAudience.Public
@InterfaceStability.Stable
void setApplicationAttemptId(ApplicationAttemptId applicationAttemptId)

Set the ApplicationAttemptId being managed by the ApplicationMaster.

Parameters:

applicationAttemptId - ApplicationAttemptId being managed by the ApplicationMaster

getHost

@InterfaceAudience.Public
@InterfaceStability.Stable
String getHost()

Get the host on which the ApplicationMaster is running.

Returns:

host on which the ApplicationMaster is running

setHost

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setHost(String host)

Set the host on which the ApplicationMaster is running.

Parameters:

host - host on which the ApplicationMaster is running

getRpcPort

@InterfaceAudience.Public
@InterfaceStability.Stable
int getRpcPort()

Get the RPC port on which the ApplicationMaster is responding.

Returns:

the RPC port on which the ApplicationMaster is responding

setRpcPort

@InterfaceAudience.Public
@InterfaceStability.Stable
void setRpcPort(int port)

Set the RPC port on which the ApplicationMaster is responding.

Parameters:

port - RPC port on which the ApplicationMaster is responding

getTrackingUrl

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

Get the tracking URL for the ApplicationMaster.

Returns:

tracking URL for the ApplicationMaster

setTrackingUrl

@InterfaceAudience.Public
@InterfaceStability.Stable
void setTrackingUrl(String trackingUrl)

Set the tracking URL for the ApplicationMaster.

Parameters:

trackingUrl - tracking URL for the ApplicationMaster