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.RuntimeAuthor;
023import org.apache.reef.proto.ReefServiceProtos;
024import org.apache.reef.runtime.common.driver.evaluator.pojos.State;
025import org.apache.reef.tang.annotations.DefaultImplementation;
026import org.apache.reef.util.Optional;
027
028import java.util.List;
029
030/**
031 * Event from Driver Runtime to Driver Process.
032 * A status update from the Driver Runtime to the Driver Process
033 */
034@RuntimeAuthor
035@DriverSide
036@DefaultImplementation(RuntimeStatusEventImpl.class)
037public interface RuntimeStatusEvent {
038  /**
039   * @return Name of the Runtime
040   */
041  String getName();
042
043  /**
044   * @return State of the Runtime
045   */
046  State getState();
047
048  /**
049   * @return List of allocated containers
050   */
051  List<String> getContainerAllocationList();
052
053  /**
054   * @return Error from the Runtime
055   */
056  Optional<ReefServiceProtos.RuntimeErrorProto> getError();
057
058  /**
059   * @return Number of outstanding container requests
060   */
061  Optional<Integer> getOutstandingContainerRequests();
062}