| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.hadoop.yarn.server.resourcemanager.reservation; |
| |
| import java.util.Map; |
| |
| import org.apache.hadoop.yarn.api.records.ReservationDefinition; |
| import org.apache.hadoop.yarn.api.records.ReservationId; |
| import org.apache.hadoop.yarn.api.records.Resource; |
| |
| import com.google.common.annotations.VisibleForTesting; |
| |
| /** |
| * A ReservationAllocation represents a concrete allocation of resources over |
| * time that satisfy a certain {@link ReservationDefinition}. This is used |
| * internally by a {@link Plan} to store information about how each of the |
| * accepted {@link ReservationDefinition} have been allocated. |
| */ |
| public interface ReservationAllocation |
| extends Comparable<ReservationAllocation> { |
| |
| /** |
| * Returns the unique identifier {@link ReservationId} that represents the |
| * reservation |
| * |
| * @return reservationId the unique identifier {@link ReservationId} that |
| * represents the reservation |
| */ |
| ReservationId getReservationId(); |
| |
| /** |
| * Returns the original {@link ReservationDefinition} submitted by the client |
| * |
| * @return the {@link ReservationDefinition} submitted by the client |
| */ |
| ReservationDefinition getReservationDefinition(); |
| |
| /** |
| * Returns the time at which the reservation is activated. |
| * |
| * @return the time at which the reservation is activated |
| */ |
| long getStartTime(); |
| |
| /** |
| * Returns the time at which the reservation terminates. |
| * |
| * @return the time at which the reservation terminates |
| */ |
| long getEndTime(); |
| |
| /** |
| * Returns the map of resources requested against the time interval for which |
| * they were. |
| * |
| * @return the allocationRequests the map of resources requested against the |
| * time interval for which they were |
| */ |
| Map<ReservationInterval, Resource> getAllocationRequests(); |
| |
| /** |
| * Return a string identifying the plan to which the reservation belongs |
| * |
| * @return the plan to which the reservation belongs |
| */ |
| String getPlanName(); |
| |
| /** |
| * Returns the user who requested the reservation |
| * |
| * @return the user who requested the reservation |
| */ |
| String getUser(); |
| |
| /** |
| * Returns whether the reservation has gang semantics or not |
| * |
| * @return true if there is a gang request, false otherwise |
| */ |
| boolean containsGangs(); |
| |
| /** |
| * Sets the time at which the reservation was accepted by the system |
| * |
| * @param acceptedAt the time at which the reservation was accepted by the |
| * system |
| */ |
| void setAcceptanceTimestamp(long acceptedAt); |
| |
| /** |
| * Returns the time at which the reservation was accepted by the system |
| * |
| * @return the time at which the reservation was accepted by the system |
| */ |
| long getAcceptanceTime(); |
| |
| /** |
| * Returns the capacity represented by cumulative resources reserved by the |
| * reservation at the specified point of time |
| * |
| * @param tick the time (UTC in ms) for which the reserved resources are |
| * requested |
| * @return the resources reserved at the specified time |
| */ |
| Resource getResourcesAtTime(long tick); |
| |
| /** |
| * Return a RLE representation of used resources. |
| * |
| * @return a RLE encoding of resources allocated over time. |
| */ |
| RLESparseResourceAllocation getResourcesOverTime(); |
| |
| |
| /** |
| * Return a RLE representation of used resources. |
| * |
| * @param start start of the time interval. |
| * @param end end of the time interval. |
| * @return a RLE encoding of resources allocated over time. |
| */ |
| RLESparseResourceAllocation getResourcesOverTime(long start, long end); |
| |
| /** |
| * Get the periodicity of this reservation representing the time period of the |
| * periodic job. Period is represented in milliseconds for periodic jobs. |
| * Period is 0 for non-periodic jobs. |
| * |
| * @return periodicity of this reservation |
| */ |
| long getPeriodicity(); |
| |
| /** |
| * Set the periodicity of this reservation representing the time period of the |
| * periodic job. Period is represented in milliseconds for periodic jobs. |
| * Period is 0 for non-periodic jobs. |
| * |
| * @param period periodicity of this reservation |
| */ |
| @VisibleForTesting |
| void setPeriodicity(long period); |
| |
| } |