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.protocolrecords; 020 021 import org.apache.hadoop.classification.InterfaceAudience.Private; 022 import org.apache.hadoop.classification.InterfaceAudience.Public; 023 import org.apache.hadoop.classification.InterfaceStability.Stable; 024 import org.apache.hadoop.classification.InterfaceStability.Unstable; 025 import org.apache.hadoop.yarn.api.ApplicationClientProtocol; 026 import org.apache.hadoop.yarn.api.records.ApplicationId; 027 import org.apache.hadoop.yarn.api.records.Resource; 028 import org.apache.hadoop.yarn.util.Records; 029 030 /** 031 * <p>The response sent by the <code>ResourceManager</code> to the client for 032 * a request to get a new {@link ApplicationId} for submitting applications.</p> 033 * 034 * @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest) 035 */ 036 @Public 037 @Stable 038 public abstract class GetNewApplicationResponse { 039 040 @Private 041 @Unstable 042 public static GetNewApplicationResponse newInstance( 043 ApplicationId applicationId, Resource minCapability, 044 Resource maxCapability) { 045 GetNewApplicationResponse response = 046 Records.newRecord(GetNewApplicationResponse.class); 047 response.setApplicationId(applicationId); 048 response.setMaximumResourceCapability(maxCapability); 049 return response; 050 } 051 052 /** 053 * Get the <em>new</em> <code>ApplicationId</code> allocated by the 054 * <code>ResourceManager</code>. 055 * @return <em>new</em> <code>ApplicationId</code> allocated by the 056 * <code>ResourceManager</code> 057 */ 058 @Public 059 @Stable 060 public abstract ApplicationId getApplicationId(); 061 062 @Private 063 @Unstable 064 public abstract void setApplicationId(ApplicationId applicationId); 065 066 /** 067 * Get the maximum capability for any {@link Resource} allocated by the 068 * <code>ResourceManager</code> in the cluster. 069 * @return maximum capability of allocated resources in the cluster 070 */ 071 @Public 072 @Stable 073 public abstract Resource getMaximumResourceCapability(); 074 075 @Private 076 @Unstable 077 public abstract void setMaximumResourceCapability(Resource capability); 078 }