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

Class ReservationId

java.lang.Object

org.apache.hadoop.yarn.api.records.ReservationId

All Implemented Interfaces:

java.lang.Comparable<ReservationId>

@Public
@Unstable
public abstract class ReservationId
extends java.lang.Object
implements java.lang.Comparable<ReservationId>

ReservationId represents the globally unique identifier for a reservation.

The globally unique nature of the identifier is achieved by using the cluster timestamp i.e. start-time of the ResourceManager along with a monotonically increasing counter for the reservation.

Field Summary

Fields

Modifier and Type	Field	Description
protected long	clusterTimestamp
protected long	id
static java.lang.String	reserveIdStrPrefix

Constructor Summary

Constructors

Constructor	Description
ReservationId()

Method Summary

Modifier and Type	Method	Description
protected abstract void	build()
int	compareTo(ReservationId other)
boolean	equals(java.lang.Object obj)
abstract long	getClusterTimestamp()	Get the start time of the ResourceManager which is used to generate globally unique ReservationId.
abstract long	getId()	Get the long identifier of the ReservationId which is unique for all Reservations started by a particular instance of the ResourceManager.
int	hashCode()
static ReservationId	newInstance(long clusterTimestamp, long id)
static ReservationId	parseReservationId(java.lang.String reservationId)	Parse the string argument as a ReservationId
protected abstract void	setClusterTimestamp(long clusterTimestamp)
protected abstract void	setId(long id)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

reserveIdStrPrefix

@Private
@Unstable
public static final java.lang.String reserveIdStrPrefix

See Also:

Constant Field Values

clusterTimestamp

protected long clusterTimestamp

id

protected long id

Constructor Detail

ReservationId

public ReservationId()

Method Detail

newInstance

@Private
@Unstable
public static ReservationId newInstance(long clusterTimestamp,
                                        long id)

getId

@Public
@Unstable
public abstract long getId()

Get the long identifier of the ReservationId which is unique for all Reservations started by a particular instance of the ResourceManager.

Returns:

long identifier of the ReservationId

setId

@Private
@Unstable
protected abstract void setId(long id)

getClusterTimestamp

@Public
@Unstable
public abstract long getClusterTimestamp()

Get the start time of the ResourceManager which is used to generate globally unique ReservationId.

Returns:

start time of the ResourceManager

setClusterTimestamp

@Private
@Unstable
protected abstract void setClusterTimestamp(long clusterTimestamp)

build

protected abstract void build()

compareTo

public int compareTo(ReservationId other)

Specified by:

compareTo in interface java.lang.Comparable<ReservationId>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseReservationId

@Public
@Unstable
public static ReservationId parseReservationId(java.lang.String reservationId)
                                        throws java.io.IOException

Parse the string argument as a ReservationId

Parameters:

reservationId - the string representation of the ReservationId

Returns:

the ReservationId corresponding to the input string if valid, null if input is null

Throws:

java.io.IOException - if unable to parse the input string

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object