| /** |
| * 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.protocolrecords; |
| |
| import org.apache.hadoop.classification.InterfaceAudience.Public; |
| import org.apache.hadoop.classification.InterfaceStability.Stable; |
| import org.apache.hadoop.classification.InterfaceStability.Unstable; |
| import org.apache.hadoop.yarn.api.ApplicationClientProtocol; |
| import org.apache.hadoop.yarn.api.records.ApplicationId; |
| import org.apache.hadoop.yarn.util.Records; |
| |
| /** |
| * <p>The request sent by the client to the <code>ResourceManager</code> |
| * to abort a submitted application.</p> |
| * |
| * <p>The request includes the {@link ApplicationId} of the application to be |
| * aborted.</p> |
| * |
| * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest) |
| */ |
| @Public |
| @Stable |
| public abstract class KillApplicationRequest { |
| |
| @Public |
| @Stable |
| public static KillApplicationRequest newInstance(ApplicationId applicationId) { |
| KillApplicationRequest request = |
| Records.newRecord(KillApplicationRequest.class); |
| request.setApplicationId(applicationId); |
| return request; |
| } |
| |
| /** |
| * Get the <code>ApplicationId</code> of the application to be aborted. |
| * @return <code>ApplicationId</code> of the application to be aborted |
| */ |
| @Public |
| @Stable |
| public abstract ApplicationId getApplicationId(); |
| |
| @Public |
| @Stable |
| public abstract void setApplicationId(ApplicationId applicationId); |
| |
| /** |
| * Get the <em>diagnostics</em> to which the application is being killed. |
| * @return <em>diagnostics</em> to which the application is being killed |
| */ |
| @Public |
| @Unstable |
| public abstract String getDiagnostics(); |
| |
| /** |
| * Set the <em>diagnostics</em> to which the application is being killed. |
| * @param diagnostics <em>diagnostics</em> to which the application is being |
| * killed |
| */ |
| @Public |
| @Unstable |
| public abstract void setDiagnostics(String diagnostics); |
| } |