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.Public;
022 import org.apache.hadoop.classification.InterfaceStability.Stable;
023 import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
024 import org.apache.hadoop.yarn.api.records.ApplicationId;
025 import org.apache.hadoop.yarn.util.Records;
026
027 /**
028 * <p>The request sent by the client to the <code>ResourceManager</code>
029 * to abort a submitted application.</p>
030 *
031 * <p>The request includes the {@link ApplicationId} of the application to be
032 * aborted.</p>
033 *
034 * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)
035 */
036 @Public
037 @Stable
038 public abstract class KillApplicationRequest {
039
040 @Public
041 @Stable
042 public static KillApplicationRequest newInstance(ApplicationId applicationId) {
043 KillApplicationRequest request =
044 Records.newRecord(KillApplicationRequest.class);
045 request.setApplicationId(applicationId);
046 return request;
047 }
048
049 /**
050 * Get the <code>ApplicationId</code> of the application to be aborted.
051 * @return <code>ApplicationId</code> of the application to be aborted
052 */
053 @Public
054 @Stable
055 public abstract ApplicationId getApplicationId();
056
057 @Public
058 @Stable
059 public abstract void setApplicationId(ApplicationId applicationId);
060 }