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.yarn.api.ApplicationClientProtocol;
024import org.apache.hadoop.yarn.api.records.ApplicationAttemptId;
025import org.apache.hadoop.yarn.util.Records;
026
027/**
028 * <p>The request sent by the client to the <code>ResourceManager</code>
029 * to fail an application attempt.</p>
030 *
031 * <p>The request includes the {@link ApplicationAttemptId} of the attempt to
032 * be failed.</p>
033 *
034 * @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)
035 */
036@Public
037@Stable
038public abstract class FailApplicationAttemptRequest {
039
040  @Public
041  @Stable
042  public static FailApplicationAttemptRequest newInstance(
043      ApplicationAttemptId attemptId) {
044    FailApplicationAttemptRequest request =
045        Records.newRecord(FailApplicationAttemptRequest.class);
046    request.setApplicationAttemptId(attemptId);
047    return request;
048  }
049
050  /**
051   * Get the <code>ApplicationAttemptId</code> of the attempt to be failed.
052   * @return <code>ApplicationAttemptId</code> of the attempt.
053   */
054  @Public
055  @Stable
056  public abstract ApplicationAttemptId getApplicationAttemptId();
057
058  @Public
059  @Stable
060  public abstract void setApplicationAttemptId(
061      ApplicationAttemptId applicationAttemptId);
062}