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, software 013 * distributed under the License is distributed on an "AS IS" BASIS, 014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 015 * See the License for the specific language governing permissions and 016 * limitations under the License. 017 */ 018 package org.apache.hadoop.yarn.api.protocolrecords; 019 020 import java.util.Set; 021 022 import org.apache.hadoop.classification.InterfaceAudience.Private; 023 import org.apache.hadoop.classification.InterfaceAudience.Public; 024 import org.apache.hadoop.classification.InterfaceStability.Evolving; 025 import org.apache.hadoop.classification.InterfaceStability.Unstable; 026 import org.apache.hadoop.yarn.api.records.ContainerId; 027 028 /** 029 * Enumeration of particular allocations to be reclaimed. The platform will 030 * reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM) 031 * may attempt to checkpoint work or adjust its execution plan to accommodate 032 * it. In contrast to {@link PreemptionContract}, the AM has no flexibility in 033 * selecting which resources to return to the cluster. 034 * @see PreemptionMessage 035 */ 036 @Public 037 @Evolving 038 public interface StrictPreemptionContract { 039 040 /** 041 * Get the set of {@link PreemptionContainer} specifying containers owned by 042 * the <code>ApplicationMaster</code> that may be reclaimed by the 043 * <code>ResourceManager</code>. 044 * @return the set of {@link ContainerId} to be preempted. 045 */ 046 @Public 047 @Evolving 048 public Set<PreemptionContainer> getContainers(); 049 050 @Private 051 @Unstable 052 public void setContainers(Set<PreemptionContainer> containers); 053 054 }