org.apache.hadoop.yarn.api.records
Class ReservationDefinition

java.lang.Object
  org.apache.hadoop.yarn.api.records.ReservationDefinition

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract class ReservationDefinition
extends Object

ReservationDefinition captures the set of resource and time constraints the user cares about regarding a reservation.

See Also:

ResourceRequest

Constructor Summary

ReservationDefinition()

Method Summary

abstract long	getArrival() Get the arrival time or the earliest time from which the resource(s) can be allocated.
abstract long	getDeadline() Get the deadline or the latest time by when the resource(s) must be allocated.
abstract String	getReservationName() Get the name for this reservation.
abstract ReservationRequests	getReservationRequests() Get the list of ReservationRequests representing the resources required by the application
static ReservationDefinition	newInstance(long arrival, long deadline, ReservationRequests reservationRequests, String name)
abstract void	setArrival(long earliestStartTime) Set the arrival time or the earliest time from which the resource(s) can be allocated.
abstract void	setDeadline(long latestEndTime) Set the deadline or the latest time by when the resource(s) must be allocated.
abstract void	setReservationName(String name) Set the name for this reservation.
abstract void	setReservationRequests(ReservationRequests reservationRequests) Set the list of ReservationRequests representing the resources required by the application

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservationDefinition

public ReservationDefinition()

Method Detail

newInstance

@InterfaceAudience.Public
@InterfaceStability.Unstable
public static ReservationDefinition newInstance(long arrival,
                                                                                                     long deadline,
                                                                                                     ReservationRequests reservationRequests,
                                                                                                     String name)

getArrival

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract long getArrival()

Get the arrival time or the earliest time from which the resource(s) can be allocated. Time expressed as UTC.

Returns:

the earliest valid time for this reservation

setArrival

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract void setArrival(long earliestStartTime)

Set the arrival time or the earliest time from which the resource(s) can be allocated. Time expressed as UTC.

Parameters:

earliestStartTime - the earliest valid time for this reservation

getDeadline

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract long getDeadline()

Get the deadline or the latest time by when the resource(s) must be allocated. Time expressed as UTC.

Returns:

the deadline or the latest time by when the resource(s) must be allocated

setDeadline

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract void setDeadline(long latestEndTime)

Set the deadline or the latest time by when the resource(s) must be allocated. Time expressed as UTC.

Parameters:

latestEndTime - the deadline or the latest time by when the resource(s) should be allocated

getReservationRequests

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract ReservationRequests getReservationRequests()

Get the list of ReservationRequests representing the resources required by the application

Returns:

the list of ReservationRequests

setReservationRequests

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract void setReservationRequests(ReservationRequests reservationRequests)

Set the list of ReservationRequests representing the resources required by the application

Parameters:

reservationRequests - the list of ReservationRequests

getReservationName

@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract String getReservationName()

Get the name for this reservation. The name need-not be unique, and it is just a mnemonic for the user (akin to job names). Accepted reservations are uniquely identified by a system-generated ReservationId.

Returns:

string representing the name of the corresponding reserved resource allocation in the scheduler

setReservationName

@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract void setReservationName(String name)

Set the name for this reservation. The name need-not be unique, and it is just a mnemonic for the user (akin to job names). Accepted reservations are uniquely identified by a system-generated ReservationId.

Parameters:

name - representing the name of the corresponding reserved resource allocation in the scheduler