org.apache.hive.spark.client

Interface JobHandle<T extends Serializable>

All Superinterfaces:

Future<T>

@InterfaceAudience.Private
public interface JobHandle<T extends Serializable>
extends Future<T>

A handle to a submitted job. Allows for monitoring and controlling of the running remote job.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JobHandle.Listener<T extends Serializable> A listener for monitoring the state of the job in the remote context.
static class	JobHandle.State The current state of the submitted job.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(JobHandle.Listener<T> l) Add a listener to the job handle.
String	getClientJobId() The client job ID.
MetricsCollection	getMetrics() A collection of metrics collected from the Spark jobs triggered by this job.
SparkCounters	getSparkCounters() Get the SparkCounters for this job.
List<Integer>	getSparkJobIds() Get corresponding spark job IDs for this job.
JobHandle.State	getState() Return the current state of the job.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

getClientJobId

String getClientJobId()

The client job ID. This is unrelated to any Spark jobs that might be triggered by the submitted job.

getMetrics

MetricsCollection getMetrics()

A collection of metrics collected from the Spark jobs triggered by this job. To collect job metrics on the client, Spark jobs must be registered with JobContext::monitor() on the remote end.

getSparkJobIds

List<Integer> getSparkJobIds()

Get corresponding spark job IDs for this job.

getSparkCounters

SparkCounters getSparkCounters()

Get the SparkCounters for this job.

getState

JobHandle.State getState()

Return the current state of the job.

addListener

void addListener(JobHandle.Listener<T> l)

Add a listener to the job handle. If the job's state is not SENT, a callback for the corresponding state will be invoked immediately.

Parameters:

l - The listener to add.