001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.runtime.common.driver.resourcemanager;
020
021import org.apache.reef.annotations.audience.DriverSide;
022import org.apache.reef.annotations.audience.RuntimeAuthor;
023import org.apache.reef.tang.annotations.DefaultImplementation;
024import org.apache.reef.util.Optional;
025
026/**
027 * Event from Driver Runtime -> Driver Process
028 * A Resource allocated by the Driver Runtime. In response to a ResourceRequestEvent.
029 */
030@RuntimeAuthor
031@DriverSide
032@DefaultImplementation(ResourceAllocationEventImpl.class)
033public interface ResourceAllocationEvent {
034
035  /**
036   * @return Id of the allocated resource
037   */
038  String getIdentifier();
039
040  /**
041   * @return Memory size of the resource, in MB
042   */
043  int getResourceMemory();
044
045  /**
046   * @return Id of the node where resource was allocated
047   */
048  String getNodeId();
049
050  /**
051   * @return Number of virtual CPU cores on the resource
052   */
053  Optional<Integer> getVirtualCores();
054}