org.apache.hadoop.yarn.server.resourcemanager.reservation

Interface PlanView

All Superinterfaces:

PlanContext

All Known Subinterfaces:

Plan, PlanEdit

All Known Implementing Classes:

InMemoryPlan

public interface PlanView
extends PlanContext

This interface provides a read-only view on the allocations made in this plan. This methods are used for example by ReservationAgents to determine the free resources in a certain point in time, and by PlanFollowerPolicy to publish this plan to the scheduler.

Method Summary

Methods

Modifier and Type	Method and Description
Set<ReservationAllocation>	getAllReservations() Gets all the reservations in the plan
RLESparseResourceAllocation	getAvailableResourceOverTime(String user, org.apache.hadoop.yarn.api.records.ReservationId oldId, long start, long end) This method returns the amount of resources available to a given user (optionally if removing a certain reservation) over the start-end time range.
RLESparseResourceAllocation	getConsumptionForUserOverTime(String user, long start, long end) This method returns a RLE encoded view of the user reservation utilization between start and end time.
long	getEarliestStartTime() Gets the time (UTC in ms) at which the first reservation starts
long	getLastEndTime() Returns the time (UTC in ms) at which the last reservation terminates
ReservationAllocation	getReservationById(org.apache.hadoop.yarn.api.records.ReservationId reservationID) Return a ReservationAllocation identified by its ReservationId
Set<ReservationAllocation>	getReservationByUserAtTime(String user, long t) Return a set of ReservationAllocation that belongs to a certain user and overlaps time t.
RLESparseResourceAllocation	getReservationCountForUserOverTime(String user, long start, long end) This method returns a RLE encoded view of the user reservation count utilization between start and end time.
Set<ReservationAllocation>	getReservations(org.apache.hadoop.yarn.api.records.ReservationId reservationID, ReservationInterval interval) Return a set of ReservationAllocation identified by any user.
Set<ReservationAllocation>	getReservations(org.apache.hadoop.yarn.api.records.ReservationId reservationID, ReservationInterval interval, String user) Return a set of ReservationAllocation identified by the user who made the reservation.
Set<ReservationAllocation>	getReservationsAtTime(long tick) Gets all the active reservations at the specified point of time
org.apache.hadoop.yarn.api.records.Resource	getTotalCapacity() Returns the overall capacity in terms of Resource assigned to this plan (typically will correspond to the absolute capacity of the corresponding queue).
org.apache.hadoop.yarn.api.records.Resource	getTotalCommittedResources(long tick) Returns the total Resource reserved for all users at the specified time

Methods inherited from interface org.apache.hadoop.yarn.server.resourcemanager.reservation.PlanContext

getMaximumAllocation, getMinimumAllocation, getMoveOnExpiry, getQueueMetrics, getQueueName, getReplanner, getReservationAgent, getResourceCalculator, getSharingPolicy, getStep

Method Detail

getReservations

Set<ReservationAllocation> getReservations(org.apache.hadoop.yarn.api.records.ReservationId reservationID,
                                         ReservationInterval interval,
                                         String user)

Return a set of ReservationAllocation identified by the user who made the reservation.

Parameters:

reservationID - the unqiue id to identify the ReservationAllocation

interval - the time interval used to retrieve the reservation allocations from. Only reservations with start time no greater than the interval end time, and end time no less than the interval start time will be selected.

user - the user to retrieve the reservation allocation from.

Returns:

a set of ReservationAllocation identified by the user who made the reservation

getReservations

Set<ReservationAllocation> getReservations(org.apache.hadoop.yarn.api.records.ReservationId reservationID,
                                         ReservationInterval interval)

Return a set of ReservationAllocation identified by any user.

Parameters:

reservationID - the unqiue id to identify the ReservationAllocation

interval - the time interval used to retrieve the reservation allocations from. Only reservations with start time no greater than the interval end time, and end time no less than the interval start time will be selected.

Returns:

a set of ReservationAllocation identified by any user

getReservationById

ReservationAllocation getReservationById(org.apache.hadoop.yarn.api.records.ReservationId reservationID)

Return a ReservationAllocation identified by its ReservationId

Parameters:

reservationID - the unique id to identify the ReservationAllocation

Returns:

ReservationAllocation identified by the specified id

getReservationByUserAtTime

Set<ReservationAllocation> getReservationByUserAtTime(String user,
                                                    long t)

Return a set of ReservationAllocation that belongs to a certain user and overlaps time t.

Parameters:

user - the user being considered

t - the instant in time being considered

Returns:

set of active ReservationAllocations for this user at this time

getReservationsAtTime

Set<ReservationAllocation> getReservationsAtTime(long tick)

Gets all the active reservations at the specified point of time

Parameters:

tick - the time (UTC in ms) for which the active reservations are requested

Returns:

set of active reservations at the specified time

getAllReservations

Set<ReservationAllocation> getAllReservations()

Gets all the reservations in the plan

Returns:

set of all reservations handled by this Plan

getTotalCommittedResources

org.apache.hadoop.yarn.api.records.Resource getTotalCommittedResources(long tick)

Returns the total Resource reserved for all users at the specified time

Parameters:

tick - the time (UTC in ms) for which the reserved resources are requested

Returns:

the total Resource reserved for all users at the specified time

getTotalCapacity

org.apache.hadoop.yarn.api.records.Resource getTotalCapacity()

Returns the overall capacity in terms of Resource assigned to this plan (typically will correspond to the absolute capacity of the corresponding queue).

Returns:

the overall capacity in terms of Resource assigned to this plan

getEarliestStartTime

long getEarliestStartTime()

Gets the time (UTC in ms) at which the first reservation starts

Returns:

the time (UTC in ms) at which the first reservation starts

getLastEndTime

long getLastEndTime()

Returns the time (UTC in ms) at which the last reservation terminates

Returns:

the time (UTC in ms) at which the last reservation terminates

getAvailableResourceOverTime

RLESparseResourceAllocation getAvailableResourceOverTime(String user,
                                                       org.apache.hadoop.yarn.api.records.ReservationId oldId,
                                                       long start,
                                                       long end)
                                                         throws PlanningException

This method returns the amount of resources available to a given user (optionally if removing a certain reservation) over the start-end time range.

Parameters:

user -

oldId -

start -

end -

Returns:

a view of the plan as it is available to this user

Throws:

PlanningException

getReservationCountForUserOverTime

RLESparseResourceAllocation getReservationCountForUserOverTime(String user,
                                                             long start,
                                                             long end)

This method returns a RLE encoded view of the user reservation count utilization between start and end time.

Parameters:

user -

start -

end -

Returns:

RLE encoded view of reservation used over time

getConsumptionForUserOverTime

RLESparseResourceAllocation getConsumptionForUserOverTime(String user,
                                                        long start,
                                                        long end)

This method returns a RLE encoded view of the user reservation utilization between start and end time.

Parameters:

user -

start -

end -

Returns:

RLE encoded view of resources used over time