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.driver.evaluator;
020
021import org.apache.reef.driver.catalog.NodeDescriptor;
022
023/**
024 * Metadata about an Evaluator.
025 */
026public interface EvaluatorDescriptor {
027
028  /**
029   * @return the NodeDescriptor of the node where this Evaluator is running.
030   */
031  NodeDescriptor getNodeDescriptor();
032
033  /**
034   * @return the process to be run on the Evaluator.
035   */
036  EvaluatorProcess getProcess();
037
038  /**
039   * @return the amount of memory allocated to this Evaluator.
040   */
041  int getMemory();
042
043  /**
044   * @return the number of virtual core allocated to this Evaluator.
045   */
046  int getNumberOfCores();
047
048  /**
049   * @return name of the runtime that was used to allocate this Evaluator
050   */
051  String getRuntimeName();
052}