Class

org.apache.livy.scalaapi

ScalaJobHandle

Related Doc: package scalaapi

Permalink

class ScalaJobHandle[T] extends Future[T]

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

Linear Supertypes
Future[T], Awaitable[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaJobHandle
  2. Future
  3. Awaitable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def andThen[U](pf: PartialFunction[Try[T], U])(implicit executor: ExecutionContext): Future[T]

    Permalink
    Definition Classes
    Future
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[S](pf: PartialFunction[T, S])(implicit executor: ExecutionContext): Future[S]

    Permalink
    Definition Classes
    Future
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def failed: Future[Throwable]

    Permalink
    Definition Classes
    Future
  11. def fallbackTo[U >: T](that: Future[U]): Future[U]

    Permalink
    Definition Classes
    Future
  12. def filter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]

    Permalink
    Definition Classes
    Future
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def flatMap[S](f: (T) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]

    Permalink
    Definition Classes
    Future
  15. def foreach[U](f: (T) ⇒ U)(implicit executor: ExecutionContext): Unit

    Permalink
    Definition Classes
    Future
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def isCompleted: Boolean

    Permalink

    Returns whether the job has already been completed with a value or an exception.

    Returns whether the job has already been completed with a value or an exception.

    Note: using this method yields nondeterministic dataflow programs.

    returns

    true if the job is already completed, false otherwise.

    Definition Classes
    ScalaJobHandle → Future
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def map[S](f: (T) ⇒ S)(implicit executor: ExecutionContext): Future[S]

    Permalink
    Definition Classes
    Future
  21. def mapTo[S](implicit tag: ClassTag[S]): Future[S]

    Permalink
    Definition Classes
    Future
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def onComplete[U](func: (Try[T]) ⇒ U)(implicit executor: ExecutionContext): Unit

    Permalink

    When the job is completed, either through an exception, or a value, apply the provided function.

    When the job is completed, either through an exception, or a value, apply the provided function.

    If the job has already been completed, this will either be applied immediately or be scheduled asynchronously.

    Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

    The provided callback always runs in the provided implicit ExecutionContext, though there is no guarantee that the execute() method on the ExecutionContext will be called once per callback or that execute() will be called in the current thread. That is, the implementation may run multiple callbacks in a batch within a single execute() and it may run execute() either immediately or asynchronously.

    Definition Classes
    ScalaJobHandle → Future
  26. def onFailure[U](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Unit

    Permalink
    Definition Classes
    Future
  27. def onJobCancelled[U](func: (Boolean) ⇒ Unit)(implicit executor: ExecutionContext): Unit

    Permalink

    When this job is cancelled, apply the provided function.

    When this job is cancelled, apply the provided function.

    Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

    The provided callback always runs in the provided implicit ExecutionContext, though there is no guarantee that the execute() method on the ExecutionContext will be called once per callback or that execute() will be called in the current thread. That is, the implementation may run multiple callbacks in a batch within a single execute() and it may run execute() either immediately or asynchronously.

  28. def onJobQueued[U](func: ⇒ Unit)(implicit executor: ExecutionContext): Unit

    Permalink

    When this job is queued, apply the provided function.

    When this job is queued, apply the provided function.

    Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

    The provided callback always runs in the provided implicit ExecutionContext, though there is no guarantee that the execute() method on the ExecutionContext will be called once per callback or that execute() will be called in the current thread. That is, the implementation may run multiple callbacks in a batch within a single execute() and it may run execute() either immediately or asynchronously.

  29. def onJobStarted[U](func: ⇒ Unit)(implicit executor: ExecutionContext): Unit

    Permalink

    When this job has started, apply the provided function.

    When this job has started, apply the provided function.

    Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

    The provided callback always runs in the provided implicit ExecutionContext, though there is no guarantee that the execute() method on the ExecutionContext will be called once per callback or that execute() will be called in the current thread. That is, the implementation may run multiple callbacks in a batch within a single execute() and it may run execute() either immediately or asynchronously.

  30. def onSuccess[U](pf: PartialFunction[T, U])(implicit executor: ExecutionContext): Unit

    Permalink
    Definition Classes
    Future
  31. def ready(atMost: Duration)(implicit permit: CanAwait): ScalaJobHandle.this.type

    Permalink

    Supports Scala's Await.ready(atmost) which awaits the completion of the job.

    Supports Scala's Await.ready(atmost) which awaits the completion of the job.

    atMost

    maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration.

    returns

    ScalaJobHandle

    Definition Classes
    ScalaJobHandle → Awaitable
    Annotations
    @throws( classOf[InterruptedException] ) @throws( classOf[TimeoutException] )
    Exceptions thrown

    InterruptedException if the current thread is interrupted while waiting.

    TimeoutException if after waiting for the specified time the job is still not ready.

  32. def recover[U >: T](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Future[U]

    Permalink
    Definition Classes
    Future
  33. def recoverWith[U >: T](pf: PartialFunction[Throwable, Future[U]])(implicit executor: ExecutionContext): Future[U]

    Permalink
    Definition Classes
    Future
  34. def result(atMost: Duration)(implicit permit: CanAwait): T

    Permalink

    Supports Scala's Await.result(atmost) which awaits the completion of the job and returns the result (of type T).

    Supports Scala's Await.result(atmost) which awaits the completion of the job and returns the result (of type T).

    atMost

    maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration.

    returns

    the result value if job is completed within the specific maximum wait time.

    Definition Classes
    ScalaJobHandle → Awaitable
    Annotations
    @throws( classOf[Exception] )
    Exceptions thrown

    Exception the underlying exception on the execution of the job.

  35. def state: State

    Permalink

    Return the current state of the job.

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. def transform[S](f: (Try[T]) ⇒ Try[S])(implicit executor: ExecutionContext): Future[S]

    Permalink
  39. def transform[S](s: (T) ⇒ S, f: (Throwable) ⇒ Throwable)(implicit executor: ExecutionContext): Future[S]

    Permalink
    Definition Classes
    Future
  40. def transformWith[S](f: (Try[T]) ⇒ Future[S])(implicit executor: ExecutionContext): Future[S]

    Permalink
  41. def value: Option[Try[T]]

    Permalink

    The result value of the job.

    The result value of the job.

    If the job is not completed the returned value will be None. If the job is completed the value will be Some(Success(t)). if it contains a valid result, or Some(Failure(error)) if it contains an exception.

    Definition Classes
    ScalaJobHandle → Future
  42. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def withFilter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]

    Permalink
    Definition Classes
    Future
  46. def zip[U](that: Future[U]): Future[(T, U)]

    Permalink
    Definition Classes
    Future

Inherited from Future[T]

Inherited from Awaitable[T]

Inherited from AnyRef

Inherited from Any

Ungrouped