org.apache.hadoop.yarn.server.api.ApplicationTerminationContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hadoop-yarn-api Show documentation

There is a newer version: 3.4.0

/**
* 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.server.api;

import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Evolving;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.api.records.ApplicationId;

/**
 * Initialization context for {@link AuxiliaryService} when stopping an
 * application.
 * 
 */
@Public
@Evolving
public class ApplicationTerminationContext {

  private final ApplicationId applicationId;

  @Private
  @Unstable
  public ApplicationTerminationContext(ApplicationId applicationId) {
    this.applicationId = applicationId;
  }

  /**
   * Get {@link ApplicationId} of the application being stopped.
   * 
   * @return applications ID
   */
  public ApplicationId getApplicationId() {
    return this.applicationId;
  }
}