Package org.apache.hadoop.yarn.api.records

Class ApplicationTimeout

java.lang.Object

org.apache.hadoop.yarn.api.records.ApplicationTimeout

@Public
@Unstable
public abstract class ApplicationTimeout
extends Object

ApplicationTimeout is a report for configured application timeouts. It includes details such as:

• ApplicationTimeoutType of the timeout type.
• Expiry time in ISO8601 standard with format yyyy-MM-dd'T'HH:mm:ss.SSSZ or "UNLIMITED".
• Remaining time in seconds.

The possible values for {ExpiryTime, RemainingTimeInSeconds} are

• {UNLIMITED,-1} : Timeout is not configured for given timeout type (LIFETIME).
• {ISO8601 date string, 0} : Timeout is configured and application has completed.
• {ISO8601 date string, greater than zero} : Timeout is configured and application is RUNNING. Application will be timed out after configured value.

Constructor Summary

Constructors

Constructor	Description
ApplicationTimeout()

Method Summary

Modifier and Type	Method	Description
abstract String	getExpiryTime()	Get expiryTime for given timeout type.
abstract long	getRemainingTime()	Get Remaining Time of an application for given timeout type.
abstract ApplicationTimeoutType	getTimeoutType()	Get the application timeout type.
static ApplicationTimeout	newInstance(ApplicationTimeoutType type, String expiryTime, long remainingTime)
abstract void	setExpiryTime(String expiryTime)	Set expiryTime for given timeout type.
abstract void	setRemainingTime(long remainingTime)	Set Remaining Time of an application for given timeout type.
abstract void	setTimeoutType(ApplicationTimeoutType timeoutType)	Set the application timeout type.

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationTimeout

public ApplicationTimeout()

Method Details

newInstance

@Public
@Unstable
public static ApplicationTimeout newInstance(ApplicationTimeoutType type,
 String expiryTime,
 long remainingTime)

getTimeoutType

@Public
@Unstable
public abstract ApplicationTimeoutType getTimeoutType()

Get the application timeout type.

Returns:

timeoutType of an application timeout.

setTimeoutType

@Public
@Unstable
public abstract void setTimeoutType(ApplicationTimeoutType timeoutType)

Set the application timeout type.

Parameters:

timeoutType - of an application timeout.

getExpiryTime

@Public
@Unstable
public abstract String getExpiryTime()

Get expiryTime for given timeout type.

Returns:

expiryTime in ISO8601 standard with format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

setExpiryTime

@Public
@Unstable
public abstract void setExpiryTime(String expiryTime)

Set expiryTime for given timeout type.

Parameters:

expiryTime - in ISO8601 standard with format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

getRemainingTime

@Public
@Unstable
public abstract long getRemainingTime()

Get Remaining Time of an application for given timeout type.

Returns:

Remaining Time in seconds.

setRemainingTime

@Public
@Unstable
public abstract void setRemainingTime(long remainingTime)

Set Remaining Time of an application for given timeout type.

Parameters:

remainingTime - in seconds.