org.apache.flink.runtime.resourcemanager.slotmanager.ResourceActions Maven / Gradle / Ivy
/*
* 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.api.common.JobID;
import org.apache.flink.runtime.clusterframework.types.AllocationID;
import org.apache.flink.runtime.clusterframework.types.ResourceProfile;
import org.apache.flink.runtime.instance.InstanceID;
import org.apache.flink.runtime.resourcemanager.exceptions.ResourceManagerException;
import org.apache.flink.runtime.resourcemanager.placementconstraint.SlotTag;
import java.util.List;
import java.util.Set;
/**
* Resource related actions which the {@link SlotManager} can perform.
*/
public interface ResourceActions {
/**
* Releases the resource with the given instance id.
*
* @param instanceId identifying which resource to release
* @param cause why the resource is released
*/
void releaseResource(InstanceID instanceId, Exception cause);
/**
* Requests to allocate a resource with the given {@link ResourceProfile}.
*
* @param resourceProfile for the to be allocated resource
* @throws ResourceManagerException if the resource cannot be allocated
*/
void allocateResource(ResourceProfile resourceProfile) throws ResourceManagerException;
/**
* Requests to allocate a resource with the given {@link ResourceProfile} and {@link SlotTag}s.
*
* @param resourceProfile for the to be allocated resource
* @param tags for the to be allocated resource
* @throws ResourceManagerException if the resource cannot be allocated
*/
void allocateResource(ResourceProfile resourceProfile, Set tags) throws ResourceManagerException;
/**
* Batch allocate resources with the given {@link ResourceProfile}s and {@link SlotTag}s.
*
* The resource manager should guarantee either all resource requirements are accepted
* or all requirements are rejected.
*
* @param resourceProfiles for the to be allocated resources
* @param slotsTags for the to be allocated resources
* @throws ResourceManagerException if the resource cannot be allocated
*/
void allocateResources(List resourceProfiles, List> slotsTags) throws ResourceManagerException;
/**
* Notifies that an allocation failure has occurred.
*
* @param jobId to which the allocation belonged
* @param allocationId identifying the failed allocation
* @param cause of the allocation failure
*/
void notifyAllocationFailure(JobID jobId, AllocationID allocationId, Exception cause);
/**
* Cancel a previous allocation of a resource with the given {@link ResourceProfile}.
*
* @param resourceProfile for the to be allocated resource
*/
void cancelResourceAllocation(ResourceProfile resourceProfile);
/**
* Cancel a previous allocation of a resource with the given {@link ResourceProfile} and {@link SlotTag}s.
*
* @param resourceProfile for the to be allocated resource
* @param tags for the to be allocated resource
*/
void cancelResourceAllocation(ResourceProfile resourceProfile, Set tags);
}