hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/records/PreemptionResourceRequest.java

/**
 * 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.hadoop.yarn.api.records;

import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceStability.Evolving;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest;
import org.apache.hadoop.yarn.util.Records;

/**
 * Description of resources requested back by the cluster.
 * @see PreemptionContract
 * @see AllocateRequest#setAskList(java.util.List)
 */
@Public
@Evolving
public abstract class PreemptionResourceRequest {

  @Private
  @Unstable
  public static PreemptionResourceRequest newInstance(ResourceRequest req) {
    PreemptionResourceRequest request =
        Records.newRecord(PreemptionResourceRequest.class);
    request.setResourceRequest(req);
    return request;
  }

  /**
   * @return Resource described in this request, to be matched against running
   * containers.
   */
  @Public
  @Evolving
  public abstract ResourceRequest getResourceRequest();

  @Private
  @Unstable
  public abstract void setResourceRequest(ResourceRequest req);
}