org.apache.hadoop.yarn.api.protocolrecords

Class ReservationUpdateRequest

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest

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

ReservationUpdateRequest captures the set of requirements the user has to update an existing reservation.

See Also:

ReservationDefinition

Constructor Summary

Constructors

Constructor and Description
ReservationUpdateRequest()

Method Summary

Methods

Modifier and Type	Method and Description
abstract ReservationDefinition	getReservationDefinition() Get the ReservationDefinition representing the updated user constraints for this reservation
abstract ReservationId	getReservationId() Get the ReservationId, that corresponds to a valid resource allocation in the scheduler (between start and end time of this reservation)
static ReservationUpdateRequest	newInstance(ReservationDefinition reservationDefinition, ReservationId reservationId)
abstract void	setReservationDefinition(ReservationDefinition reservationDefinition) Set the ReservationDefinition representing the updated user constraints for this reservation
abstract void	setReservationId(ReservationId reservationId) Set the ReservationId, that correspond to a valid resource allocation in the scheduler (between start and end time of this reservation)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservationUpdateRequest

public ReservationUpdateRequest()

Method Detail

newInstance

@InterfaceAudience.Public
@InterfaceStability.Unstable
public static ReservationUpdateRequest newInstance(ReservationDefinition reservationDefinition,
                                                                                        ReservationId reservationId)

getReservationDefinition

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract ReservationDefinition getReservationDefinition()

Get the ReservationDefinition representing the updated user constraints for this reservation

Returns:

the reservation definition representing user constraints

setReservationDefinition

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract void setReservationDefinition(ReservationDefinition reservationDefinition)

Set the ReservationDefinition representing the updated user constraints for this reservation

Parameters:

reservationDefinition - the reservation request representing the reservation

getReservationId

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract ReservationId getReservationId()

Get the ReservationId, that corresponds to a valid resource allocation in the scheduler (between start and end time of this reservation)

Returns:

the ReservationId representing the unique id of the corresponding reserved resource allocation in the scheduler

setReservationId

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract void setReservationId(ReservationId reservationId)

Set the ReservationId, that correspond to a valid resource allocation in the scheduler (between start and end time of this reservation)

Parameters:

reservationId - the ReservationId representing the the unique id of the corresponding reserved resource allocation in the scheduler