org.apache.flink.runtime.resourcemanager.slotmanager.SlotMatchingStrategy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation

There is a newer version: 1.19.0

/*
 * 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.flink.runtime.resourcemanager.slotmanager;

import org.apache.flink.runtime.clusterframework.types.ResourceProfile;
import org.apache.flink.runtime.instance.InstanceID;

import java.util.Collection;
import java.util.Optional;
import java.util.function.Function;

/** Strategy how to find a matching slot. */
public interface SlotMatchingStrategy {

    /**
     * Finds a matching slot for the requested {@link ResourceProfile} given the collection of free
     * slots and the total number of slots per TaskExecutor.
     *
     * @param requestedProfile to find a matching slot for
     * @param freeSlots collection of free slots
     * @param numberRegisteredSlotsLookup lookup for the number of registered slots
     * @return Returns a matching slots or {@link Optional#empty()} if there is none
     */
     Optional findMatchingSlot(
            ResourceProfile requestedProfile,
            Collection freeSlots,
            Function numberRegisteredSlotsLookup);
}