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.api.protocolrecords.AllocateRequest;
025    import org.apache.hadoop.yarn.util.Records;
026    
027    /**
028     * Description of resources requested back by the cluster.
029     * @see PreemptionContract
030     * @see AllocateRequest#setAskList(java.util.List)
031     */
032    @Public
033    @Evolving
034    public abstract class PreemptionResourceRequest {
035    
036      @Private
037      @Unstable
038      public static PreemptionResourceRequest newInstance(ResourceRequest req) {
039        PreemptionResourceRequest request =
040            Records.newRecord(PreemptionResourceRequest.class);
041        request.setResourceRequest(req);
042        return request;
043      }
044    
045      /**
046       * @return Resource described in this request, to be matched against running
047       * containers.
048       */
049      @Public
050      @Evolving
051      public abstract ResourceRequest getResourceRequest();
052    
053      @Private
054      @Unstable
055      public abstract void setResourceRequest(ResourceRequest req);
056    }