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