twill-yarn/src/main/java/org/apache/twill/internal/yarn/YarnAppClient.java

/*
 * 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.twill.internal.yarn;

import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.NodeReport;
import org.apache.twill.api.TwillSpecification;
import org.apache.twill.internal.ProcessController;
import org.apache.twill.internal.ProcessLauncher;
import org.apache.twill.internal.appmaster.ApplicationMasterInfo;

import java.util.List;
import javax.annotation.Nullable;

/**
 * Interface for launching Yarn application from client.
 */
public interface YarnAppClient {

  /**
   * Creates a {@link ProcessLauncher} for launching the application represented by the given spec. If scheduler queue
   * is available and is supported by the YARN cluster, it will be launched in the given queue.
   */
  ProcessLauncher<ApplicationMasterInfo> createLauncher(TwillSpecification twillSpec,
                                                        @Nullable String schedulerQueue) throws Exception;

  /**
   * Creates a {@link ProcessLauncher} for launching application with the given user and spec. If scheduler queue
   * is available and is supported by the YARN cluster, it will be launched in the given queue.
   *
   * @deprecated This method will get removed.
   */
  @Deprecated
  ProcessLauncher<ApplicationMasterInfo> createLauncher(String user,
                                                        TwillSpecification twillSpec,
                                                        @Nullable String schedulerQueue) throws Exception;

  /**
   * Creates a {@link ProcessController} that can controls an application represented by the given application id.
   */
  ProcessController<YarnApplicationReport> createProcessController(ApplicationId appId);

  /**
   * Returns a list of {@link org.apache.hadoop.yarn.api.records.NodeReport} for the nodes in the cluster.
   * @return a list of {@link org.apache.hadoop.yarn.api.records.NodeReport} for the nodes in the cluster.
   * @throws Exception Propagates exceptions thrown by {@link org.apache.hadoop.yarn.client.api.YarnClient}.
   */
  List<NodeReport> getNodeReports() throws Exception;
}