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.records;
019
020 import org.apache.hadoop.classification.InterfaceAudience.Public;
021 import org.apache.hadoop.classification.InterfaceAudience.Private;
022 import org.apache.hadoop.classification.InterfaceStability.Evolving;
023 import org.apache.hadoop.classification.InterfaceStability.Unstable;
024 import org.apache.hadoop.yarn.util.Records;
025
026 /**
027 * Specific container requested back by the <code>ResourceManager</code>.
028 * @see PreemptionContract
029 * @see StrictPreemptionContract
030 */
031 @Public
032 @Evolving
033 public abstract class PreemptionContainer {
034
035 @Private
036 @Unstable
037 public static PreemptionContainer newInstance(ContainerId id) {
038 PreemptionContainer container = Records.newRecord(PreemptionContainer.class);
039 container.setId(id);
040 return container;
041 }
042
043 /**
044 * @return Container referenced by this handle.
045 */
046 @Public
047 @Evolving
048 public abstract ContainerId getId();
049
050 @Private
051 @Unstable
052 public abstract void setId(ContainerId id);
053
054 }