org.apache.hive.spark.client.SparkClient Maven / Gradle / Ivy
/*
* 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.hive.spark.client;
import java.io.Serializable;
import java.net.URI;
import java.util.List;
import java.util.concurrent.Future;
import org.apache.hadoop.hive.common.classification.InterfaceAudience;
/**
* Defines the API for the Spark remote client.
*/
@InterfaceAudience.Private
public interface SparkClient extends Serializable {
/**
* Submits a job for asynchronous execution.
*
* @param job The job to execute.
* @return A handle that be used to monitor the job.
*/
JobHandle submit(Job job);
/**
* Submits a job for asynchronous execution.
*
* @param job The job to execute.
* @param listeners jobhandle listeners to invoke during the job processing
* @return A handle that be used to monitor the job.
*/
JobHandle submit(Job job, List> listeners);
/**
* Asks the remote context to run a job immediately.
*
* Normally, the remote context will queue jobs and execute them based on how many worker
* threads have been configured. This method will run the submitted job in the same thread
* processing the RPC message, so that queueing does not apply.
*
* It's recommended that this method only be used to run code that finishes quickly. This
* avoids interfering with the normal operation of the context.
*
* Note: the {@link JobContext#monitor()} functionality is not available when using this method.
*
* @param job The job to execute.
* @return A future to monitor the result of the job.
*/
Future run(Job job);
/**
* Stops the remote context.
*
* Any pending jobs will be cancelled, and the remote context will be torn down.
*/
void stop();
/**
* Adds a jar file to the running remote context.
*
* Note that the URL should be reachable by the Spark driver process. If running the driver
* in cluster mode, it may reside on a different host, meaning "file:" URLs have to exist
* on that node (and not on the client machine).
*
* @param uri The location of the jar file.
* @return A future that can be used to monitor the operation.
*/
Future> addJar(URI uri);
/**
* Adds a file to the running remote context.
*
* Note that the URL should be reachable by the Spark driver process. If running the driver
* in cluster mode, it may reside on a different host, meaning "file:" URLs have to exist
* on that node (and not on the client machine).
*
* @param uri The location of the file.
* @return A future that can be used to monitor the operation.
*/
Future> addFile(URI uri);
/**
* Get the count of executors.
*/
Future getExecutorCount();
/**
* Get default parallelism. For standalone mode, this can be used to get total number of cores.
*/
Future getDefaultParallelism();
/**
* Check if remote context is still active.
*/
boolean isActive();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy