Source code

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.Private;
023import org.apache.reef.util.Optional;
024
025/**
026 * An interface capturing the characteristics of a resource event.
027 */
028@DriverSide
029@Private
030public interface ResourceEvent {
031
032  /**
033   * @return Id of the resource
034   */
035  String getIdentifier();
036
037  /**
038   * @return Memory size of the resource, in MB
039   */
040  int getResourceMemory();
041
042  /**
043   * @return Id of the node where resource is
044   */
045  String getNodeId();
046
047  /**
048   * @return Number of virtual CPU cores on the resource
049   */
050  Optional<Integer> getVirtualCores();
051
052  /**
053   * @return Rack name of the resource
054   */
055  Optional<String> getRackName();
056
057  /**
058   * @return Runtime name of the resource
059   */
060  String getRuntimeName();
061}