heron/spi/src/java/org/apache/heron/spi/scheduler/IScalable.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.heron.spi.scheduler;

import java.util.Set;

import org.apache.heron.classification.InterfaceAudience;
import org.apache.heron.classification.InterfaceStability;
import org.apache.heron.spi.packing.PackingPlan;

/**
 * Schedulers that implement {@code IScalable} support scaling topologies up or down by
 * adding or removing containers.
 */
@InterfaceAudience.LimitedPrivate
@InterfaceStability.Unstable
public interface IScalable {
  /**
   * Requests new containers for scaling a topology
   *
   * @param containersToAdd Set of containers to be added by the scheduler
   * @return Set of added containers with real ids and resources from the scheduler
   */
  Set<PackingPlan.ContainerPlan> addContainers(Set<PackingPlan.ContainerPlan> containersToAdd);

  /**
   * Requests containers to be released for down-scaling a topology.
   *
   * @param containersToRemove Set of containers to be removed by the scheduler
   */
  void removeContainers(Set<PackingPlan.ContainerPlan> containersToRemove);
}