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 019 package org.apache.hadoop.yarn.api.records; 020 021 import org.apache.hadoop.classification.InterfaceAudience.Private; 022 import org.apache.hadoop.classification.InterfaceAudience.Public; 023 import org.apache.hadoop.classification.InterfaceStability.Evolving; 024 import org.apache.hadoop.yarn.util.Records; 025 026 @Public 027 @Evolving 028 public abstract class ResourceOption { 029 030 public static ResourceOption newInstance(Resource resource, 031 int overCommitTimeout){ 032 ResourceOption resourceOption = Records.newRecord(ResourceOption.class); 033 resourceOption.setResource(resource); 034 return resourceOption; 035 } 036 037 /** 038 * Get the <em>resource</em> of the ResourceOption. 039 * @return <em>resource</em> of the ResourceOption 040 */ 041 @Private 042 @Evolving 043 public abstract Resource getResource(); 044 045 @Private 046 @Evolving 047 protected abstract void setResource(Resource resource); 048 049 /** 050 * Get timeout for tolerant of resource over-commitment 051 * Note: negative value means no timeout so that allocated containers will 052 * keep running until the end even under resource over-commitment cases. 053 * @return <em>overCommitTimeout</em> of the ResourceOption 054 */ 055 @Private 056 @Evolving 057 public abstract int getOverCommitTimeout(); 058 059 @Private 060 @Evolving 061 protected abstract void setOverCommitTimeout(int overCommitTimeout); 062 063 protected abstract void build(); 064 065 @Override 066 public String toString() { 067 return "Resource:" + getResource().toString() 068 + ", overCommitTimeout:" + getOverCommitTimeout(); 069 } 070 071 }