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
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Stable;
023import org.apache.hadoop.classification.InterfaceStability.Unstable;
024import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
025import org.apache.hadoop.yarn.api.records.ApplicationId;
026import org.apache.hadoop.yarn.util.Records;
027
028/**
029 * <p>The request sent by the client to the <code>ResourceManager</code>
030 * to abort a submitted application.</p>
031 * 
032 * <p>The request includes the {@link ApplicationId} of the application to be
033 * aborted.</p>
034 * 
035 * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)
036 */
037@Public
038@Stable
039public abstract class KillApplicationRequest {
040
041  @Public
042  @Stable 
043  public static KillApplicationRequest newInstance(ApplicationId applicationId) {
044    KillApplicationRequest request =
045        Records.newRecord(KillApplicationRequest.class);
046    request.setApplicationId(applicationId);
047    return request;
048  }
049
050  /**
051   * Get the <code>ApplicationId</code> of the application to be aborted.
052   * @return <code>ApplicationId</code> of the application to be aborted
053   */
054  @Public
055  @Stable
056  public abstract ApplicationId getApplicationId();
057  
058  @Public
059  @Stable
060  public abstract void setApplicationId(ApplicationId applicationId);
061
062  /**
063   * Get the <em>diagnostics</em> to which the application is being killed.
064   * @return <em>diagnostics</em> to which the application is being killed
065   */
066  @Public
067  @Unstable
068  public abstract String getDiagnostics();
069
070  /**
071   * Set the <em>diagnostics</em> to which the application is being killed.
072   * @param diagnostics <em>diagnostics</em> to which the application is being
073   *          killed
074   */
075  @Public
076  @Unstable
077  public abstract void setDiagnostics(String diagnostics);
078}